Queries the resources in an application group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeMonitorGroupInstances

The operation that you want to perform. Set the value to DescribeMonitorGroupInstances.
GroupId Long Yes 12345

The ID of the application group.
PageSize Integer No 10

The number of entries to return on each page. Default value: 10.
PageNumber Integer No 1

The number of the page to return. Default value: 1.
Category String No ECS

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.
Keyword String No s1

The keyword used to search for instances. Fuzzy search based on instance name is supported.
InstanceIds String No i-x1234568

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

Response parameters

Parameter Type Example Description
RequestId String 97F2A410-9412-499C-9AD1-76EF7EC02DF2

The ID of the request.
Success Boolean true

Indicates whether the call was successful.
PageNumber Integer 1

The number of the returned page.
PageSize Integer 10

The number of entries returned on each page.
Code Integer 200

The HTTP status code.

Note The status code 200 indicates that the call was successful.
Resources Array N/A

The information about the resources in the application group.
Resource N/A N/A N/A
Category String ECS

The abbreviation of the service name.
Id Long 12345

The ID of the resource.
InstanceId String i-2ze3w55tr2r****

The ID of the instance.
InstanceName String hostIP

The name of the instance.
RegionId String cn-hangzhou

The ID of the region where the instance resides.
Total Integer 12

The total number of entries returned.
Message String success

The returned message.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeMonitorGroupInstances
&GroupId=12345
&<Common request parameters>

Sample success responses

XML format 

<PageNumber>1</PageNumber>
<PageSize>30</PageSize>
<RequestId>7670220A-0725-42EE-9252-8200C4F810D9</RequestId>
<Success>true</Success>
<Code>200</Code>
<Total>1</Total>
<Resources>
    <Resource>
        <Category>ECS</Category>
        <InstanceId>i-2ze3w55tr2rcpejp****</InstanceId>
        <RegionId>cn-beijing</RegionId>
        <InstanceName>dynamic_group_1</InstanceName>
    </Resource>
</Resources>

JSON format 

{
    "PageNumber": 1,
    "PageSize": 30,
    "RequestId": "7670220A-0725-42EE-9252-8200C4F810D9",
    "Success": true,
    "Code": 200,
    "Total": 1,
    "Resources": {
        "Resource": [
            {
                "Category": "ECS",
                "InstanceId": "i-2ze3w55tr2rcpejp****",
                "RegionId": "cn-beijing",
                "InstanceName": "dynamic_group_1"
            }
        ]
    }
}

Error codes

For a list of error codes, visit the API Error Center.