Retrieve Application Groups via DescribeMonitorGroups API - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Queries the list of application groups by calling the DescribeMonitorGroups operation.

Operation description

This topic provides an example of how to query the list of application groups for the current account. The response shows that the current account has two application groups: testGroup124 and test123.

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:DescribeMonitorGroups

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SelectContactGroups	boolean	No	Specifies whether to include alert contact groups in the response. Valid values: true: Include alert contact groups. false: Do not include alert contact groups.	true
PageNumber	integer	No	The page number. Minimum value: 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Minimum value: 1. Default value: 30.	30
Keyword	string	No	The search keyword.	test
InstanceId	string	No	The resource instance ID. This parameter is used to query the application group to which the specified instance belongs.	i-abcdefgh12****
GroupName	string	No	The application group name.	testGroup124
IncludeTemplateHistory	boolean	No	Specifies whether to include the history of alert templates that have been applied to the application group in the response. Valid values: true: Include the history. false: Do not include the history.	true
Type	string	No	The type of the application group. Valid values: custom: a custom application group. ehpc_cluster: an application group synchronized from an EHPC cluster. kubernetes: an application group synchronized from Container Service for Kubernetes. tag: an application group automatically created by using tags. resMgr: an application group created from a resource group. ess: an application group synchronized from Auto Scaling (ESS). aone_group: an application group synchronized from or associated with an Aone application. Valid values: kubernetes : an application group synchronized from Container Service for Kubernetes. ehpc_cluster : an application group synchronized from an EHPC cluster. ess : an application group synchronized from Auto Scaling (ESS). resMgr : an application group created from a resource group. custom : a custom application group. tag : an application group automatically created by using tags. aone_group : an application group synchronized or associated from an Aone application.	custom
DynamicTagRuleId	string	No	The ID of the dynamic rule matching.	6b882d9a-5117-42e2-9d0c-4749a0c6****
GroupFounderTagKey	string	No	The tag key used to create the application group by using dynamic rule matching.	GroupKey1
GroupFounderTagValue	string	No	The tag value used to create the application group by using dynamic rule matching.	GroupValue1
GroupId	string	No	The application group ID. Separate multiple application group IDs with commas (,).	92****
Tag	array<object>	No	The tags of the application group.
	object	No	The tags of the application group.
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: a custom application group. ehpc_cluster: an application group synchronized from an EHPC cluster. kubernetes: an application group synchronized from Container Service for Kubernetes. tag: an application group automatically created by using tags. resMgr: an application group created from a resource group. ess: an application group synchronized from Auto Scaling (ESS). aone_group: an application group synchronized from or associated with an Aone application.	custom

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F02B299A-D374-4595-9F55-7534D604F132
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true
Code	integer	The status code. Note The value 200 indicates success.	200
Message	string	The error message.	The specified resource is not found.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	30
Total	integer	The total number of entries.	10
Resources	object
Resource	array<object>	The associated resources.
	array<object>	The associated resources.
Type	string	The type of the application group. Valid values: custom: a custom application group. ehpc_cluster: an application group synchronized from an EHPC cluster. kubernetes: an application group synchronized from Container Service for Kubernetes. tag: an application group automatically created by using tags. resMgr: an application group created from a resource group. ess: an application group synchronized from Auto Scaling (ESS). aone_group: an application group synchronized from or associated with an Aone application.	custom
GroupFounderTagValue	string	The tag value used to create the application group by using dynamic rule matching.	GroupValue1
BindUrl	string	The URL synchronized from Container Service for Kubernetes.	https://aliyun.com
GroupName	string	The application group name.	test123
GroupId	integer	The application group ID.	12345
ServiceId	string	The Alibaba Cloud service ID.	49****
DynamicTagRuleId	string	The ID of the dynamic rule matching.	6b882d9a-5117-42e2-9d0c-4749a0c6****
GmtCreate	integer	The timestamp when the application group was created. Unit: milliseconds.	1603181891000
GroupFounderTagKey	string	The tag key used to create the application group by using dynamic rule matching.	GroupKey1
GmtModified	integer	The timestamp when the application group was modified. Unit: milliseconds.	1603181891000
ContactGroups	object
ContactGroup	array<object>	The alert contact groups.
	object	The alert contact group.
Name	string	The name of the alert contact group.	CloudMonitor
Tags	object
Tag	array<object>	The tags bound to the application group.
	object	The tags bound to the application group.
Key	string	The tag key of the application group.	tagKey1
Value	string	The tag value of the application group.	tagValue1
TemplateIds	object
TemplateId	array	The template IDs.
	string	The alert templates that have been applied to the application group.	92****
ResourceGroupId	string	The resource group ID.	rg-aek2hopjh*******
TemplateInfos	object
TemplateInfo	array<object>	The template information.
	object	The template information.
EffectTime	integer	The effective period. The data type is Long. The format is a UNIX timestamp in milliseconds, representing the number of milliseconds elapsed since 1970-01-01 00:00:00 UTC.	1603181891000
TemplateId	string	The template IDs.	123***
Ver	string	The version.	0

Examples

Success response

JSON format

{
  "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*******",
        "TemplateInfos": {
          "TemplateInfo": [
            {
              "EffectTime": 1603181891000,
              "TemplateId": "123***",
              "Ver": "0"
            }
          ]
        }
      }
    ]
  }
}

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.