DescribeMonitorGroupInstanceAttribute - Cloud Monitor - Alibaba Cloud Documentation Center

Queries the details of the resources in an application group.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeMonitorGroupInstanceAttribute

get

*MonitorGroupInstances

acs:cms::{#accountId}:group/{#groupId}

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	integer	Yes	The ID of the application group.	123456
PageNumber	integer	No	The page number. Valid values: 1 to 1000000000. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 1000000000. Default value: 10.	10
Total	boolean	No	Specifies whether to return the total number of resources in the specified application group. Valid values: true (default) false	true
Category	string	No	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
Keyword	string	No	The keyword that is used to search for resources.	portal
InstanceIds	string	No	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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9FB8EA79-7279-4482-8D6D-3D28EEDD871A
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	integer	The responses code. Note The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	The specified resource is not found.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	2
Total	integer	The total number of entries returned.	12
Resources	object
Resource	array<object>	The resources that are associated with the application group.
	array<object>
InstanceName	string	The instance name.	hostName
Dimension	string	The dimensions of the resource that is associated with the application group.	{"instanceId":"i-m5e0k0bexac8tykr****"}
Category	string	The name of the cloud service.	ecs
InstanceId	string	The instance ID.	i-m5e0k0bexac8tykr****
NetworkType	string	The network type.	vpc
Desc	string	The resource description.	desc_test
Tags	object
Tag	array<object>	The tag of the resource.
	object
Key	string	The tag key.	instanceNetworkType
Value	string	The tag value.	VPC
Region	object	The region.
AvailabilityZone	string	The zone.	cn-hangzhou-f
RegionId	string	The region ID.	cn-hangzhou
Vpc	object	The VPC description.
VswitchInstanceId	string	The vSwitch ID.	vsw-2ze36seq79n992****
VpcInstanceId	string	The VPC ID.	vpc-2zew7etgiceg21****

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	ParameterInvalid	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	The request processing has failed due to some unknown error.
402	LimitExceeded	The quota for this customer had been reached.
403	AccessForbidden	The X.509 certificate or cms access key ID provided does not exist in our records.
206	%s	%s
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
503	%s	%s
406	%s	%s
429	Throttli∂ngException	The request was denied due to request throttling.
409	%s	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.