All Products
Search
Document Center

CloudMonitor:DescribeMonitorGroupInstances

Last Updated:Mar 01, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerNo

The number of entries to return on each page. Default value: 10.

10
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
GroupIdlongYes

The ID of the application group.

12345
CategorystringNo

The abbreviation of the name of the service to which the instances in the application group belong. Valid values:

  • ECS: Elastic Compute Service (ECS) instances provided by Alibaba Cloud and hosts not provided by Alibaba Cloud
  • RDS: ApsaraDB for RDS
  • ADS: AnalyticDB
  • SLB: Server Load Balancer (SLB)
  • VPC: Virtual Private Cloud (VPC)
  • APIGATEWAY: API Gateway
  • CDN: Alibaba Cloud Content Delivery Network (CDN)
  • CS: Container Service for Swarm
  • DCDN: Dynamic Route for CDN
  • DDoS: Anti-DDoS Pro
  • EIP: Elastic IP Address (EIP)
  • ELASTICSEARCH: Elasticsearch
  • EMR: E-MapReduce
  • ESS: Auto Scaling
  • HBASE: ApsaraDB for Hbase
  • IOT_EDGE: IoT Edge
  • K8S_POD: pods in Container Service for Kubernetes
  • KVSTORE_SHARDING: ApsaraDB for Redis of the cluster architecture
  • KVSTORE_SPLITRW: ApsaraDB for Redis of the read/write splitting architecture
  • KVSTORE_STANDARD: ApsaraDB for Redis of the standard architecture
  • MEMCACHE: ApsaraDB for Memcache
  • MNS: Message Service (MNS)
  • MONGODB: ApsaraDB for MongoDB of the replica set architecture
  • MONGODB_CLUSTER: ApsaraDB for MongoDB of the cluster architecture
  • MONGODB_SHARDING: ApsaraDB for MongoDB of the sharded cluster architecture
  • MQ_TOPIC: MNS topics
  • OCS: ApsaraDB for Memcache of earlier versions
  • OPENSEARCH: Open Search
  • OSS: Object Storage Service (OSS)
  • POLARDB: PolarDB
  • PETADATA: HybridDB for MySQL
  • SCDN: Secure Content Delivery Network (SCDN)
  • SHAREBANDWIDTHPACKAGES: EIP Bandwidth Plan
  • SLS: Log Service
  • VPN: VPN Gateway

Valid values of N: 1 to 200.

ecs
KeywordstringNo

The keyword used to search for instances. Fuzzy search based on instance name is supported.

s1
InstanceIdsstringNo

The ID of the instance. You can query multiple instances by specifying multiple IDs.

i-x1234568

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

97F2A410-9412-499C-9AD1-76EF7EC02DF2
Successboolean

Indicates whether the call was successful.

true
Codeinteger

The HTTP status code.

Note The status code 200 indicates that the call was successful.
200
Messagestring

The returned message.

success
PageNumberinteger

The number of the returned page.

1
PageSizeinteger

The number of entries returned on each page.

10
Resourcesobject []

The information about the resources in the application group.

Categorystring

The abbreviation of the service name.

ecs
InstanceIdstring

The ID of the instance.

i-2ze3w55tr2r****
InstanceNamestring

The name of the instance.

hostIP
Idlong

The ID of the resource.

12345
RegionIdstring

The ID of the region where the instance resides.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "97F2A410-9412-499C-9AD1-76EF7EC02DF2",
  "Success": true,
  "Code": 200,
  "Message": "success",
  "PageNumber": 1,
  "PageSize": 10,
  "Total": 12,
  "Resources": {
    "Resource": [
      {
        "Category": "ecs",
        "InstanceId": "i-2ze3w55tr2r****",
        "InstanceName": "hostIP",
        "Id": 12345,
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400ParameterInvalid%s-
401AccessDeniedExceptionYou donot have sufficient access to perform this action.-
402LimitExceededThe quota for this customer had been reached.-
403AccessForbiddenThe X.509 certificate or cms access key ID provided does not exist in our records.-
404ResourceNotFoundThe specified resource is not found.The specified resource is not found.
406%s%s-
429Throttli∂ngExceptionThe request was denied due to request throttling.-
500InternalErrorThe request processing has failed due to some unknown error.-

For a list of error codes, visit the Service error codes.