DescribeContactGroupList - Cloud Monitor - Alibaba Cloud Documentation Center

Call the DescribeContactGroupList interface to query the list of alarm contact groups.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	Number of records per page.	10
PageNumber	integer	No	Page number.	1

Response elements

Element	Type	Description	Example
	object
Code	string	Status code. Note that 200 indicates success.	200
Message	string	Return message.	success
RequestId	string	The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and problem localization.	916EE694-03C2-47B6-85EE-5054E3C168D3
Total	integer	Total number of records.	22
Success	boolean	Indicates whether the operation was successful. Values: true: Success. false: Failure.	true
ContactGroups	object
ContactGroup	array	List of alarm contact groups.
	string	Alarm contact group.	云账号报警联系人
ContactGroupList	object
ContactGroup	array<object>	List of alarm contact groups.
	array<object>	Alarm contact group.
Describe	string	Description information of the alarm contact group.	Devops-运维组
UpdateTime	integer	Update time.	2025-03-04T02:12:06Z
CreateTime	integer	Creation time.	2023-06-07T03:52:30Z
EnabledWeeklyReport	boolean	Indicates whether the weekly report function is enabled.	false
Name	string	Name.	name
EnableSubscribed	boolean	Indicates whether the weekly report subscription function is enabled. Values: true: Yes. false: No.	false
Contacts	object
Contact	array	List of contacts.
	string	Contact.	135xxxx8066

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "success",
  "RequestId": "916EE694-03C2-47B6-85EE-5054E3C168D3",
  "Total": 22,
  "Success": true,
  "ContactGroups": {
    "ContactGroup": [
      "云账号报警联系人"
    ]
  },
  "ContactGroupList": {
    "ContactGroup": [
      {
        "Describe": "Devops-运维组",
        "UpdateTime": 0,
        "CreateTime": 0,
        "EnabledWeeklyReport": false,
        "Name": "name",
        "EnableSubscribed": false,
        "Contacts": {
          "Contact": [
            "135xxxx8066"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
200	ResourceNotFound	The specified resource is not found.
400	InvalidParameter	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidAuthorization	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.