All Products
Search
Document Center

CloudMonitor:DescribeMonitorGroupInstances

Last Updated:Nov 07, 2024

Queries the resources in an application group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cms:DescribeMonitorGroupInstancesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerNo

The number of entries per page. Default value: 10.

10
PageNumberintegerNo

The page number. Default value: 1.

1
GroupIdlongYes

The ID of the application group.

12345
CategorystringNo

The abbreviation of the cloud service name. Valid values of N: 1 to 200.

Note For more information about how to obtain the abbreviation of a cloud service name, see metricCategory in the response parameter Labels of the DescribeProjectMeta operation.
ecs
KeywordstringNo

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

s1
InstanceIdsstringNo

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

i-x1234568

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The responses code.

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

The returned message.

success
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
RequestIdstring

The request ID.

97F2A410-9412-499C-9AD1-76EF7EC02DF2
Resourcesarray<object>

The information about the resources in the application group.

Resourceobject
Categorystring

The abbreviation of the service name.

ecs
Idlong

The resource ID.

12345
InstanceIdstring

The instance ID.

i-2ze3w55tr2r****
InstanceNamestring

The instance name.

hostIP
RegionIdstring

The ID of the region where the instance resides.

cn-hangzhou
Successboolean

Indicates whether the request was successful.

true
Totalinteger

The total number of entries returned.

12

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
206%s%s-
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.
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.