DescribeMonitorGroupInstances - Cloud Monitor - Alibaba Cloud Documentation Center

Queries 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:DescribeMonitorGroupInstances

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries per page. Default value: 10.	10
PageNumber	integer	No	The page number. Default value: 1.	1
GroupId	integer	Yes	The ID of the application group.	123****
Category	string	No	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
Keyword	string	No	The keyword used to search for instances. Fuzzy search based on instance names is supported.	test-s1
InstanceIds	string	No	The instance ID. You can query multiple instances by specifying multiple IDs.	i-bp12g4xbl4i0brkn****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	97F2A410-9412-499C-9AD1-76EF7EC02DF2
Success	boolean	Indicates whether the request was successful.	true
Code	integer	The responses code. Note The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	success
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
Total	integer	The total number of entries returned.	12
Resources	object
Resource	array<object>	The information about the resources in the application group.
	object
Category	string	The abbreviation of the service name.	ecs
InstanceId	string	The instance ID.	i-bp12g4xbl4i0brkn****
InstanceName	string	The instance name.	test-s1
Id	integer	The resource ID.	123****
RegionId	string	The ID of the region where the instance resides.	cn-hangzhou

Examples

Success response

JSON format

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

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.