CreateObservabilityServer

API Request

URLs
POST zstack/v1/observability-servers
Headers
Authorization: OAuth the-session-uuid
Body
{   "params": {     "name": "obs-1",     "observabilityServerOfferingUuid": "83475c2834f83dd59ccf8741787d800e",     "description": "desc",     "zoneUuid": "0f33fd3eee6a3b61abce2de06cb1dc24",     "clusterUuid": "8a47ef8b40e33be8880d24f496cceaf6",     "hostUuid": "b009ff2ecfe334e5b9dae2501af8c612",     "primaryStorageUuidForRootVolume": "137d4d95aded3f09a133fb9fd6197349"   },   "systemTags": [],   "userTags": [] }
Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"name":"obs-1","observabilityServerOfferingUuid":"83475c2834f83dd59ccf8741787d800e","description":"desc","zoneUuid":"0f33fd3eee6a3b61abce2de06cb1dc24","clusterUuid":"8a47ef8b40e33be8880d24f496cceaf6","hostUuid":"b009ff2ecfe334e5b9dae2501af8c612","primaryStorageUuidForRootVolume":"137d4d95aded3f09a133fb9fd6197349"}}' \ http://localhost:8080/zstack/v1/observability-servers
Request Parameters
Name Type Location Description Valid Values Starting Version
name String body (contained in the params structure) The resource name. 5.3.28
observabilityServerOfferingUuid String body (contained in the params structure) 5.3.28
description String body (contained in the params structure) Optional. The resource description. 5.3.28
zoneUuid String body (contained in the params structure) Optional. The zone UUID. 5.3.28
clusterUuid String body (contained in the params structure) Optional. The cluster UUID. 5.3.28
hostUuid String body (contained in the params structure) Optional. The host UUID. 5.3.28
primaryStorageUuidForRootVolume String body (contained in the params structure) Optional. 5.3.28
rootVolumeSystemTags List body (contained in the params structure) Optional. 5.3.28
resourceUuid String body (contained in the params structure) Optional. The resource UUID. 5.3.28
tagUuids List body (contained in the params structure) Optional. The tag UUID list. 5.3.28
systemTags List body Optional. The system tag. 5.3.28
userTags List body Optional. The user tag. 5.3.28

API Response

Sample Response
{   "inventory": {} }
Name Type Description Starting Version
success boolean 5.3.28
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error 5.3.28
inventory VmInstanceInventory See inventory 5.3.28
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 5.3.28
description String The brief description of the error. 5.3.28
details String The details about the error. 5.3.28
elaboration String The reserved field. Default value: null. 5.3.28
opaque LinkedHashMap The reserved field. Default value: null. 5.3.28
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 5.3.28
#inventory
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
name String The resource name. 5.3.28
description String The resource description. 5.3.28
zoneUuid String The zone UUID. 5.3.28
clusterUuid String The cluster UUID. 5.3.28
imageUuid String The image UUID. 5.3.28
hostUuid String The host UUID. 5.3.28
lastHostUuid String 5.3.28
instanceOfferingUuid String The instance offering UUID. 5.3.28
rootVolumeUuid String The root volume UUID. 5.3.28
platform String 5.3.28
architecture String 5.3.28
defaultL3NetworkUuid String 5.3.28
type String 5.3.28
hypervisorType String 5.3.28
memorySize Long 5.3.28
reservedMemorySize Long 5.3.28
cpuNum Integer 5.3.28
cpuSpeed Long 5.3.28
allocatorStrategy String 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28
state String 5.3.28
guestOsType String 5.3.28
vmNics List See vmNics 5.3.28
allVolumes List See allVolumes 5.3.28
vmCdRoms List See vmCdRoms 5.3.28
#vmNics
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
vmInstanceUuid String The VM UUID. 5.3.28
l3NetworkUuid String The L3 network UUID. 5.3.28
ip String 5.3.28
mac String 5.3.28
hypervisorType String 5.3.28
netmask String 5.3.28
gateway String 5.3.28
metaData String 5.3.28
ipVersion Integer 5.3.28
driverType String 5.3.28
internalName String 5.3.28
deviceId Integer 5.3.28
type String 5.3.28
state String 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28
usedIps List See usedIps 5.3.28
#usedIps
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
ipRangeUuid String The IP range UUID. 5.3.28
l3NetworkUuid String The L3 network UUID. 5.3.28
ipVersion Integer 5.3.28
ip String 5.3.28
netmask String 5.3.28
gateway String 5.3.28
usedFor String 5.3.28
ipInLong long 5.3.28
ipInBinary byte[] 5.3.28
vmNicUuid String The VM NIC UUID. 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28
#allVolumes
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
name String The resource name. 5.3.28
description String The resource description. 5.3.28
primaryStorageUuid String The primary storage UUID. 5.3.28
vmInstanceUuid String The VM UUID. 5.3.28
diskOfferingUuid String The disk offering UUID. 5.3.28
rootImageUuid String 5.3.28
installPath String 5.3.28
type String 5.3.28
format String 5.3.28
size Long 5.3.28
actualSize Long 5.3.28
deviceId Integer 5.3.28
state String 5.3.28
status String 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28
isShareable Boolean 5.3.28
volumeQos String 5.3.28
lastDetachDate Timestamp 5.3.28
lastVmInstanceUuid String 5.3.28
lastAttachDate Timestamp 5.3.28
protocol String 5.3.28
#vmCdRoms
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
vmInstanceUuid String The VM UUID. 5.3.28
deviceId Integer 5.3.28
isoUuid String 5.3.28
isoInstallPath String 5.3.28
name String The resource name. 5.3.28
description String The resource description. 5.3.28
protocol String 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28

SDK

Java SDK
CreateObservabilityServerAction action = new CreateObservabilityServerAction(); action.name = "obs-1"; action.observabilityServerOfferingUuid = "83475c2834f83dd59ccf8741787d800e"; action.description = "desc"; action.zoneUuid = "0f33fd3eee6a3b61abce2de06cb1dc24"; action.clusterUuid = "8a47ef8b40e33be8880d24f496cceaf6"; action.hostUuid = "b009ff2ecfe334e5b9dae2501af8c612"; action.primaryStorageUuidForRootVolume = "137d4d95aded3f09a133fb9fd6197349"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateObservabilityServerAction.Result res = action.call();
Python SDK
CreateObservabilityServerAction action = CreateObservabilityServerAction() action.name = "obs-1" action.observabilityServerOfferingUuid = "83475c2834f83dd59ccf8741787d800e" action.description = "desc" action.zoneUuid = "0f33fd3eee6a3b61abce2de06cb1dc24" action.clusterUuid = "8a47ef8b40e33be8880d24f496cceaf6" action.hostUuid = "b009ff2ecfe334e5b9dae2501af8c612" action.primaryStorageUuidForRootVolume = "137d4d95aded3f09a133fb9fd6197349" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" CreateObservabilityServerAction.Result res = action.call()

AttachServiceToObservabilityServer

API Request

URLs
POST zstack/v1/observability-server/{observabilityServerUuid}/service
Headers
Authorization: OAuth the-session-uuid
Body
{   "params": {     "serviceType": "loadBalancer",     "serviceUuid": "50b12612d2b4318193c2e040d98e8f7b"   },   "systemTags": [],   "userTags": [] }
Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"serviceType":"loadBalancer","serviceUuid":"50b12612d2b4318193c2e040d98e8f7b"}}' \ http://localhost:8080/zstack/v1/observability-server/3e38d4c1adb73203b35120914b12ec61/service
Request Parameters
Name Type Location Description Valid Values Starting Version
observabilityServerUuid String body (contained in the params structure) 5.3.28
serviceType String body (contained in the params structure)
  • loadBalancer
5.3.28
serviceUuid String body (contained in the params structure) 5.3.28
systemTags List body Optional. The system UUID. 5.3.28
userTags List body Optional. The user UUID. 5.3.28

API Response

Sample Response
{   "inventory": {} }
Name Type Description Starting Version
success boolean 5.3.28
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error 5.3.28
inventory ObservabilityServerVmInventory See inventory 5.3.28
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 5.3.28
description String The brief description of the error. 5.3.28
details String The details about the error. 5.3.28
elaboration String The reserved field. Default value: null. 5.3.28
opaque LinkedHashMap The reserved field. Default value: null. 5.3.28
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 5.3.28
#inventory
Name Type Description Starting Version
publicNetworkUuid String 5.3.28
applianceVmType String 5.3.28
managementNetworkUuid String 5.3.28
defaultRouteL3NetworkUuid String 5.3.28
status String 5.3.28
agentPort Integer 5.3.28
haStatus String 5.3.28
uuid String The resource UUID. 5.3.28
name String The resource name. 5.3.28
description String The resource description. 5.3.28
zoneUuid String The zone UUID. 5.3.28
clusterUuid String The cluster UUID. 5.3.28
imageUuid String The image UUID. 5.3.28
hostUuid String The host UUID. 5.3.28
lastHostUuid String 5.3.28
instanceOfferingUuid String The instance offering UUID. 5.3.28
rootVolumeUuid String The root volume UUID. 5.3.28
platform String 5.3.28
architecture String 5.3.28
defaultL3NetworkUuid String 5.3.28
type String 5.3.28
hypervisorType String 5.3.28
memorySize Long 5.3.28
reservedMemorySize Long 5.3.28
cpuNum Integer 5.3.28
cpuSpeed Long 5.3.28
allocatorStrategy String 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28
state String 5.3.28
guestOsType String 5.3.28
vmNics List See vmNics 5.3.28
allVolumes List See allVolumes 5.3.28
vmCdRoms List See vmCdRoms 5.3.28
#vmNics
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
vmInstanceUuid String The VM UUID. 5.3.28
l3NetworkUuid String The L3 network UUID. 5.3.28
ip String 5.3.28
mac String 5.3.28
hypervisorType String 5.3.28
netmask String 5.3.28
gateway String 5.3.28
metaData String 5.3.28
ipVersion Integer 5.3.28
driverType String 5.3.28
internalName String 5.3.28
deviceId Integer 5.3.28
type String 5.3.28
state String 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28
usedIps List See usedIps 5.3.28
#usedIps
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
ipRangeUuid String The IP range UUID. 5.3.28
l3NetworkUuid String The L3 network UUID. 5.3.28
ipVersion Integer 5.3.28
ip String 5.3.28
netmask String 5.3.28
gateway String 5.3.28
usedFor String 5.3.28
ipInLong long 5.3.28
ipInBinary byte[] 5.3.28
vmNicUuid String The VM NIC UUID. 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28
#allVolumes
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
name String The resource name. 5.3.28
description String The resource description. 5.3.28
primaryStorageUuid String The primary storage UUID. 5.3.28
vmInstanceUuid String The VM UUID. 5.3.28
diskOfferingUuid String The disk offering UUID. 5.3.28
rootImageUuid String 5.3.28
installPath String 5.3.28
type String 5.3.28
format String 5.3.28
size Long 5.3.28
actualSize Long 5.3.28
deviceId Integer 5.3.28
state String 5.3.28
status String 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28
isShareable Boolean 5.3.28
volumeQos String 5.3.28
lastDetachDate Timestamp 5.3.28
lastVmInstanceUuid String 5.3.28
lastAttachDate Timestamp 5.3.28
protocol String 5.3.28
#vmCdRoms
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
vmInstanceUuid String The VM UUID. 5.3.28
deviceId Integer 5.3.28
isoUuid String 5.3.28
isoInstallPath String 5.3.28
name String The resource name. 5.3.28
description String The resource description. 5.3.28
protocol String 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation ti,me. 5.3.28

SDK

Java SDK
AttachServiceToObservabilityServerAction action = new AttachServiceToObservabilityServerAction(); action.observabilityServerUuid = "3e38d4c1adb73203b35120914b12ec61"; action.serviceType = "loadBalancer"; action.serviceUuid = "50b12612d2b4318193c2e040d98e8f7b"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; AttachServiceToObservabilityServerAction.Result res = action.call();
Python SDK
AttachServiceToObservabilityServerAction action = AttachServiceToObservabilityServerAction() action.observabilityServerUuid = "3e38d4c1adb73203b35120914b12ec61" action.serviceType = "loadBalancer" action.serviceUuid = "50b12612d2b4318193c2e040d98e8f7b" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" AttachServiceToObservabilityServerAction.Result res = action.call()

DetachServiceFromObservabilityServer

API Request

URLs
DELETE zstack/v1/observability-server/{observabilityServerUuid}/service
Headers
Authorization: OAuth the-session-uuid
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X DELETE http://localhost:8080/zstack/v1/observability-server/eb4f0a1b78c139d9b291acc85ada69d0/service
Request Parameters
Name Type Location Description Valid Values Starting Version
observabilityServerUuid String body 5.3.28
serviceType String body
  • loadBalancer
5.3.28
serviceUuid String body 5.3.28
systemTags List body Optional. The system tags. 5.3.28
userTags List body Optional. The user tags. 5.3.28

API Response

Sample Response
{   "inventory": {     "uuid": "43db67751fbe3e7ca1302f06fb7264ae",     "name": "ExampleObservabilityServer",     "description": "This is an example observability server."   } }
Name Type Description Starting Version
success boolean 5.3.28
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error 5.3.28
inventory ObservabilityServerVmInventory See inventory 5.3.28
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 5.3.28
description String The brief description of the error. 5.3.28
details String The details about the error. 5.3.28
elaboration String The reserved field. Default value: null. 5.3.28
opaque LinkedHashMap The reserved field. Default value: null. 5.3.28
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 5.3.28
#inventory
Name Type Description Starting Version
publicNetworkUuid String 5.3.28
applianceVmType String 5.3.28
managementNetworkUuid String 5.3.28
defaultRouteL3NetworkUuid String 5.3.28
status String 5.3.28
agentPort Integer 5.3.28
haStatus String 5.3.28
uuid String The resource UUID. 5.3.28
name String The resource name. 5.3.28
description String The resource description. 5.3.28
zoneUuid String The zone UUID. 5.3.28
clusterUuid String The cluster UUID. 5.3.28
imageUuid String The image UUID. 5.3.28
hostUuid String The host UUID. 5.3.28
lastHostUuid String 5.3.28
instanceOfferingUuid String The instance offering UUID. 5.3.28
rootVolumeUuid String The root volume UUID. 5.3.28
platform String 5.3.28
architecture String 5.3.28
defaultL3NetworkUuid String 5.3.28
type String 5.3.28
hypervisorType String 5.3.28
memorySize Long 5.3.28
reservedMemorySize Long 5.3.28
cpuNum Integer 5.3.28
cpuSpeed Long 5.3.28
allocatorStrategy String 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28
state String 5.3.28
guestOsType String 5.3.28
vmNics List See vmNics 5.3.28
allVolumes List See allVolumes 5.3.28
vmCdRoms List See vmCdRoms 5.3.28
#vmNics
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
vmInstanceUuid String The VM UUID. 5.3.28
l3NetworkUuid String The L3 network UUID. 5.3.28
ip String 5.3.28
mac String 5.3.28
hypervisorType String 5.3.28
netmask String 5.3.28
gateway String 5.3.28
metaData String 5.3.28
ipVersion Integer 5.3.28
driverType String 5.3.28
internalName String 5.3.28
deviceId Integer 5.3.28
type String 5.3.28
state String 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28
usedIps List See usedIps 5.3.28
#usedIps
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
ipRangeUuid String The IP range UUID. 5.3.28
l3NetworkUuid String The L3 network UUID. 5.3.28
ipVersion Integer 5.3.28
ip String 5.3.28
netmask String 5.3.28
gateway String 5.3.28
usedFor String 5.3.28
ipInLong long 5.3.28
ipInBinary byte[] 5.3.28
vmNicUuid String The VM NIC UUID. 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28
#allVolumes
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
name String The resource name. 5.3.28
description String The resource description. 5.3.28
primaryStorageUuid String The primary storage UUID. 5.3.28
vmInstanceUuid String The volume UUID. 5.3.28
diskOfferingUuid String The disk offering UUID. 5.3.28
rootImageUuid String 5.3.28
installPath String 5.3.28
type String 5.3.28
format String 5.3.28
size Long 5.3.28
actualSize Long 5.3.28
deviceId Integer 5.3.28
state String 5.3.28
status String 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28
isShareable Boolean 5.3.28
volumeQos String 5.3.28
lastDetachDate Timestamp 5.3.28
lastVmInstanceUuid String 5.3.28
lastAttachDate Timestamp 5.3.28
protocol String 5.3.28
#vmCdRoms
Name Type Description Starting Version
uuid String The resource UUID. 5.3.28
vmInstanceUuid String The VM UUID. 5.3.28
deviceId Integer 5.3.28
isoUuid String 5.3.28
isoInstallPath String 5.3.28
name String The resource name. 5.3.28
description String The resource description. 5.3.28
protocol String 5.3.28
createDate Timestamp The creation time. 5.3.28
lastOpDate Timestamp The last operation time. 5.3.28

SDK

Java SDK
DetachServiceFromObservabilityServerAction action = new DetachServiceFromObservabilityServerAction(); action.observabilityServerUuid = "eb4f0a1b78c139d9b291acc85ada69d0"; action.serviceType = "loadBalancer"; action.serviceUuid = "6dd5dbdc01a6339086958415859fbb60"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; DetachServiceFromObservabilityServerAction.Result res = action.call();
Python SDK
DetachServiceFromObservabilityServerAction action = DetachServiceFromObservabilityServerAction() action.observabilityServerUuid = "eb4f0a1b78c139d9b291acc85ada69d0" action.serviceType = "loadBalancer" action.serviceUuid = "6dd5dbdc01a6339086958415859fbb60" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" DetachServiceFromObservabilityServerAction.Result res = action.call()


Archives

Download Document Archives

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

An email with a verification code will be sent to you. Make sure the address you provided is valid and correct.

同意 不同意

I have read and concur with the Site TermsPrivacy PolicyRules and Conventions on User Management of ZStack Cloud

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.
同意 不同意

I have read and concur with the Site TermsPrivacy PolicyRules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io
ZStack Training and Certification
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

同意 不同意

I have read and concur with the Site TermsPrivacy PolicyRules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io
Request Trial
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

同意 不同意

I have read and concur with the Site TermsPrivacy PolicyRules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder. After receiving the email, click the URL to download the documentation.

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder.
Or click on the URL below. (For Internet Explorer, right-click the URL and save it.)

Thank you for using ZStack products and services.

Submit successfully.

We'll connect soon.

Thank you for using ZStack products and services.