All Products
Search
Document Center

CloudMonitor:DescribeMonitorGroupInstanceAttribute

Last Updated:Jul 26, 2024

Queries the details of 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.

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:DescribeMonitorGroupInstanceAttributeget
  • MonitorGroupInstances
    acs:cms::{#accountId}:group/{#groupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdlongYes

The ID of the application group.

123456
PageNumberintegerNo

The page number.

Valid values: 1 to 1000000000.

Default value: 1.

1
PageSizeintegerNo

The number of entries per page.

Valid values: 1 to 1000000000.

Default value: 10.

10
TotalbooleanNo

Specifies whether to return the total number of resources in the specified application group. Valid values:

  • true (default)
  • false
true
CategorystringNo

The abbreviation of the cloud service name.

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 that is used to search for resources.

portal
InstanceIdsstringNo

The resource ID. Separate multiple resource IDs with commas (,). You can query the details about a maximum of 20 resources at a time.

i-m5e0k0bexac8tykr****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

9FB8EA79-7279-4482-8D6D-3D28EEDD871A
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codeinteger

The responses code.

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

The returned message.

The specified resource is not found.
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

2
Totalinteger

The total number of entries returned.

12
Resourcesarray<object>

The resources that are associated with the application group.

object
InstanceNamestring

The instance name.

hostName
Dimensionstring

The dimensions of the resource that is associated with the application group.

{"instanceId":"i-m5e0k0bexac8tykr****"}
Categorystring

The name of the cloud service.

ecs
InstanceIdstring

The instance ID.

i-m5e0k0bexac8tykr****
NetworkTypestring

The network type.

vpc
Descstring

The resource description.

desc_test
Tagsarray<object>

The tag of the resource.

object
Keystring

The tag key.

instanceNetworkType
Valuestring

The tag value.

VPC
Regionobject

The region.

AvailabilityZonestring

The zone.

cn-hangzhou-f
RegionIdstring

The region ID.

cn-hangzhou
Vpcobject

The VPC description.

VswitchInstanceIdstring

The vSwitch ID.

vsw-2ze36seq79n992****
VpcInstanceIdstring

The VPC ID.

vpc-2zew7etgiceg21****

Examples

Sample success responses

JSONformat

{
  "RequestId": "9FB8EA79-7279-4482-8D6D-3D28EEDD871A",
  "Success": true,
  "Code": 200,
  "Message": "The specified resource is not found.",
  "PageNumber": 1,
  "PageSize": 2,
  "Total": 12,
  "Resources": {
    "Resource": [
      {
        "InstanceName": "hostName",
        "Dimension": "{\"instanceId\":\"i-m5e0k0bexac8tykr****\"}",
        "Category": "ecs",
        "InstanceId": "i-m5e0k0bexac8tykr****",
        "NetworkType": "vpc",
        "Desc": "desc_test",
        "Tags": {
          "Tag": [
            {
              "Key": "instanceNetworkType",
              "Value": "VPC"
            }
          ]
        },
        "Region": {
          "AvailabilityZone": "cn-hangzhou-f",
          "RegionId": "cn-hangzhou"
        },
        "Vpc": {
          "VswitchInstanceId": "vsw-2ze36seq79n992****",
          "VpcInstanceId": "vpc-2zew7etgiceg21****"
        }
      }
    ]
  }
}

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.