DescribeMonitorGroups - CloudMonitor - Alibaba Cloud Documentation Center

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
SelectContactGroups	boolean	No	Specifies whether to include the alert contact groups in the response. Valid values: true false	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 false	true
Type	string	No	The type of the application group. Valid values: custom: a self-managed application group ehpc_cluster: an application group that is synchronized from an Elastic High Performance Computing (E-HPC) cluster kubernetes: an application group that is synchronized from a Container Service for Kubernetes (ACK) cluster	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	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 self-managed application group ehpc_cluster: an application group that is synchronized from an Elastic High Performance Computing (E-HPC) cluster kubernetes: an application group that is synchronized from a Container Service for Kubernetes (ACK) cluster tag: an application group that is automatically created by using tags resMgr: an application group that is created by using resource groups ess: an application group that is synchronized from Auto Scaling (ESS)	custom

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F02B299A-D374-4595-9F55-7534D604F132
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	integer	The HTTP status 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 of the returned page.	1
PageSize	integer	The number of entries returned per page.	30
Total	integer	The total number of returned entries.	10
Resources	object []	The resources that are associated with the application group.
Type	string	The type of the application group. Valid values: custom: a self-managed application group ehpc_cluster: an application group that is synchronized from an E-HPC cluster kubernetes: an application group that is synchronized from an ACK cluster	custom
GroupFounderTagValue	string	The tag value that is created for the application group by using the tag rule.	GroupValue1
BindUrl	string	The URL of the ACK cluster from which the application group is synchronized.	https://aliyun.com
GroupName	string	The name of the application group.	test123
GroupId	long	The ID of the application group.	12345
ServiceId	string	The ID of the Alibaba Cloud service.	49****
DynamicTagRuleId	string	The ID of the tag rule.	6b882d9a-5117-42e2-9d0c-4749a0c6****
GmtCreate	long	The timestamp when the application group was created. Unit: milliseconds.	1603181891000
GroupFounderTagKey	string	The tag key that is created for the application group by using the tag rule.	GroupKey1
GmtModified	long	The timestamp when the application group was modified. Unit: milliseconds.	1603181891000
ContactGroups	object []	The alert contact groups.
Name	string	The name of the alert contact group.	CloudMonitor
Tags	object []	The tags that are attached 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	array	The ID of the template.
	string	The alert templates that are applied to the application group.	92****
ResourceGroupId	string	The resource ID.	rg-aek2hopjh*******

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.