Queries application groups.
Operation description
This topic provides an example of how to query the application groups of the current account. The response shows that the current account has two application groups: testGroup124 and test123.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| cms:DescribeMonitorGroups | get |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| SelectContactGroups | boolean | No | Specifies whether to include the alert contact groups in the response. Valid values:
| true |
| PageNumber | integer | No | The number of the page to return. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries to return on each page. Pages start from page 1. Default value: 30. | 30 |
| Keyword | string | No | The keyword that is used for the search. | test |
| InstanceId | string | No | The instance ID. This parameter is used to query the application group to which the specified instance belongs. | i-abcdefgh12**** |
| GroupName | string | No | The name of the application group. | testGroup124 |
| IncludeTemplateHistory | boolean | No | Specifies whether to include the historical alert templates that are applied to the application group in the response. Valid values:
| true |
| Type | string | No | The type of the application group. Valid values:
| custom |
| DynamicTagRuleId | string | No | The ID of the tag rule. | 6b882d9a-5117-42e2-9d0c-4749a0c6**** |
| GroupFounderTagKey | string | No | The tag key that is created for the application group by using the tag rule. | GroupKey1 |
| GroupFounderTagValue | string | No | The tag value that is created for the application group by using the tag rule. | GroupValue1 |
| GroupId | string | No | The ID of the application group. Separate multiple application group IDs with commas (,). | 92**** |
| Tag | array<object> | No | The tags of the application group. | |
| object | No | |||
| Key | string | No | The tag key of the application group. Valid values of N: 1 to 5. | tagKey1 |
| Value | string | No | The tag value of the application group. Valid values of N: 1 to 5. | tagValue1 |
| Types | string | No | The type of the application group. Valid values:
| custom |
For more information about common request parameters, see Common parameters.
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "F02B299A-D374-4595-9F55-7534D604F132",
"Success": true,
"Code": 200,
"Message": "The specified resource is not found.",
"PageNumber": 1,
"PageSize": 30,
"Total": 10,
"Resources": {
"Resource": [
{
"Type": "custom",
"GroupFounderTagValue": "GroupValue1",
"BindUrl": "https://aliyun.com",
"GroupName": "test123",
"GroupId": 12345,
"ServiceId": "49****",
"DynamicTagRuleId": "6b882d9a-5117-42e2-9d0c-4749a0c6****",
"GmtCreate": 1603181891000,
"GroupFounderTagKey": "GroupKey1",
"GmtModified": 1603181891000,
"ContactGroups": {
"ContactGroup": [
{
"Name": "CloudMonitor"
}
]
},
"Tags": {
"Tag": [
{
"Key": "tagKey1",
"Value": "tagValue1"
}
]
},
"TemplateIds": {
"TemplateId": [
"92****"
]
},
"ResourceGroupId": "rg-aek2hopjh*******"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 206 | %s | %s | - |
| 400 | ParameterInvalid | %s | - |
| 401 | AccessDeniedException | You donot have sufficient access to perform this action. | - |
| 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. | - |
| 404 | ResourceNotFound | The specified resource is not found. | The specified resource is not found. |
| 429 | Throttli∂ngException | The request was denied due to request throttling. | - |
| 500 | InternalError | The request processing has failed due to some unknown error. | - |
For a list of error codes, visit the Service error codes.