DescribeContactListByContactGroup - Cloud Monitor - Alibaba Cloud Documentation Center

Queries the alert contacts in an alert contact group.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ContactGroupName	string	Yes	The name of the alert contact group.	CloudMonitor

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	The group is not exists.
RequestId	string	The request ID.	06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Contacts	object
Contact	array<object>	The alert contacts that receive alert notifications.
	array<object>
UpdateTime	integer	The time when the alert contact was modified. Unit: milliseconds.	1552323252000
Name	string	The name of the alert contact.	Alice
CreateTime	integer	The time when the alert contact was created. Unit: milliseconds.	1552314252000
Desc	string	The description of the alert contact.	ECS
Channels	object	The alert notification methods.
Mail	string	The email address of the alert contact.	alice@example.com
AliIM	string	The TradeManager ID of the alert contact. Note This parameter can be returned only on the China site (aliyun.com).	Alice
DingWebHook	string	The webhook URL of the DingTalk chatbot.	https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****
SMS	string	The mobile number of the alert contact. Note This parameter can be returned only on the China site (aliyun.com).	1333333****

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "The group is not exists.",
  "RequestId": "06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83",
  "Success": true,
  "Contacts": {
    "Contact": [
      {
        "UpdateTime": 1552323252000,
        "Name": "Alice",
        "CreateTime": 1552314252000,
        "Desc": "ECS",
        "Channels": {
          "Mail": "alice@example.com",
          "AliIM": "Alice",
          "DingWebHook": "https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****",
          "SMS": "1333333****"
        }
      }
    ]
  }
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.