Document navigation

Advanced Monitoring Server (Observability Server)

Overview

An advanced monitoring server is a dedicated VM instance used to receive advanced monitoring data of load balancers and other resources.

Concepts

  • Advanced Monitoring Server Image: An advanced monitoring server image encapsulates the advanced monitoring service and can be used to create advanced monitoring server.
  • Advanced Monitoring Server Offering: An advanced monitoring server offering defines the CPU cores, memory size, image, management network, and public network configurations of advanced monitoring server. You can use an advanced monitoring server offering to create advanced monitoring servers.

Operations

CreateObservabilityServer

Creates an observability server. For example,
CreateObservabilityServer name=example observabilityServerOfferingUuid=83475c2834f83dd59ccf8741787d800e

Parameters

Name Description Optional Valid Values Starting Version
name The resource name. 5.3.28
observabilityServerOfferingUuid 5.3.28
description The resource description. Yes 5.3.28
zoneUuid The zone UUID. Yes 5.3.28
clusterUuid The cluster UUID. Yes 5.3.28
hostUuid The host UUID. Yes 5.3.28
primaryStorageUuidForRootVolume Yes 5.3.28
rootVolumeSystemTags Yes 5.3.28
resourceUuid The resource UUID. Yes 5.3.28
tagUuids The tag UUID list. Yes 5.3.28
systemTags The system tags. See CreateSystemTag Yes 5.3.28
userTags The user tag. See CreateUserTag Yes 5.3.28

AttachServiceToObservabilityServer

Attaches a service to an observability server. For example,
AttachServiceToObservabilityServer observabilityServerUuid=3e38d4c1adb73203b35120914b12ec61 serviceType=loadBalancer serviceUuid=50b12612d2b4318193c2e040d98e8f7b

Parameters

Name Description Optional Valid Values Starting Version
observabilityServerUuid 5.3.28
serviceType
  • loadBalancer
5.3.28
serviceUuid 5.3.28
systemTags The system tags. See CreateSystemTag Yes 5.3.28
userTags The user tags. See CreateUserTag Yes 5.3.28

DetachServiceFromObservabilityServer

Detaches a service from an observability server. For example,
DetachServiceFromObservabilityServer observabilityServerUuid=3e38d4c1adb73203b35120914b12ec61 serviceType=loadBalancer serviceUuid=50b12612d2b4318193c2e040d98e8f7b

Parameters

Name Description Optional Valid Values Starting Version
observabilityServerUuid 5.3.28
serviceType
  • loadBalancer
5.3.28
serviceUuid 5.3.28
systemTags The system tags. See CreateSystemTag Yes 5.3.28
userTags The user tags. See CreateUserTag Yes 5.3.28

CreateObservabilityServerOffering

Creates an observability offering. For example,
CreateObservabilityServerOffering zoneUuid=08c1ec2300e13fc2985d4b42e955f620 managementNetworkUuid=5c046b968a0e3e33aa08abfe5427b083 imageUuid=4948cd5ab5e234848bdcf933a45a826f name=example cpuNumber=2 memorySize=1024

Parameters

Name Description Optional Valid Values Starting Version
zoneUuid The zone UUID. 5.3.28
managementNetworkUuid 5.3.28
imageUuid The image UUID. 5.3.28
publicNetworkUuid Yes 5.3.28
isDefault Yes 5.3.28
name The resource name. 5.3.28
description The resource description. 5.3.28
cpuNum 5.3.28
memorySize 5.3.28
reservedMemorySize Yes 5.3.28
allocatorStrategy Yes 5.3.28
sortKey Yes 5.3.28
type Yes 5.3.28
resourceUuid The resource UUID. Yes 5.3.28
tagUuids The tag UUID list. Yes 5.3.28
systemTags The system tags. See CreateSystemTag Yes 5.3.28
userTags The user tags. See CreateUserTag Yes 5.3.28

GetObservabilityServerServiceData

Gets service data of an observability server. For example,
GetObservabilityServerServiceData observabilityServerUuid=f1718b20d8cd3daba51e1b39dcf35299 serviceType=loadBalancer serviceUuid=11836e85c4d7391a8d8c54248fd89815

Parameters

Name Description Optional Valid Values Starting Version
observabilityServerUuid 5.3.28
serviceType 5.3.28
serviceUuid 5.3.28
limit Yes 5.3.28
startTime Yes 5.3.28
endTime Yes 5.3.28
sortDirection Yes 5.3.28
labelFilters Yes 5.3.28
systemTags The system tags, see CreateSystemTag Yes 5.3.28
userTags The user tags. See CreateUserTag Yes 5.3.28
CLI Command Manual | 5.5.30 | ZStack Cloud · ZCF | ZStack Resource Center