DescribeContactListByContactGroup - CloudMonitor - Alibaba Cloud Documentation Center

Queries the alert contacts in an alert contact group.

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
ContactGroupName	string	Yes	The name of the alert contact group.	CloudMonitor

Response parameters

Parameter	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 []	The alert contacts that receive alert notifications.
UpdateTime	long	The time when the alert contact was modified. Unit: milliseconds.	1552314252000
Name	string	The name of the alert contact.	Alice
CreateTime	long	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

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "The group is not exists.",
  "RequestId": "06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83",
  "Success": true,
  "Contacts": {
    "Contact": [
      {
        "UpdateTime": 1552314252000,
        "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	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