DescribeContactGroupList - CloudMonitor - Alibaba Cloud Documentation Center

Queries alert groups.

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
PageSize	integer	No	The number of entries to return on each page.	1
PageNumber	integer	No	The number of the page to return.	10

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code. Note The status code 200 indicates that the call was successful.	200
Message	string	The returned message.	The Request is not authorization.
RequestId	string	The ID of the request.	916EE694-03C2-47B6-85EE-5054E3C168D3
Total	integer	The total number of the returned entries.	22
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true
ContactGroups	array	The names of alert groups.
	string		{ "ContactGroup": [ "ECS_Group", "Jim" ] }
ContactGroupList	object []	The information about alert groups that were queried.
Describe	string	The description of the alert group.
UpdateTime	long	The time when the alert group was modified. This value is a UNIX timestamp that represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1589447759000
CreateTime	long	The time when the alert group was created. This value is a UNIX timestamp that represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1507070598000
EnabledWeeklyReport	boolean	Indicates whether the alert group can subscribe to weekly reports. Valid values: true: The alert group can subscribe to weekly reports. false: The alert group cannot subscribe to weekly reports. Note The weekly report subscription feature is only available for Alibaba Cloud accounts with more than five Elastic Compute Service (ECS) instances.	true
Name	string	The name of the alert group.	Contact1
EnableSubscribed	boolean	Indicates whether the alert group subscribes to weekly reports. Valid values: true: The alert group subscribes to weekly reports. false: The alert group does not subscribe to weekly reports.	true
Contacts	array	The alert contacts in the alert group.
	string		Jimmy

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "916EE694-03C2-47B6-85EE-5054E3C168D3",
  "Total": 22,
  "Success": true,
  "ContactGroups": {
    "ContactGroup": [
      "{ \"ContactGroup\": [ \"ECS_Group\", \"Jim\" ] }"
    ]
  },
  "ContactGroupList": {
    "ContactGroup": [
      {
        "Describe": "",
        "UpdateTime": 1589447759000,
        "CreateTime": 1507070598000,
        "EnabledWeeklyReport": true,
        "Name": "Contact1",
        "EnableSubscribed": true,
        "Contacts": {
          "Contact": [
            "Jimmy"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter	%s
403	InvalidAuthorization	%s
404	ResourceNotFound	%s
500	InternalError	The request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history