DescribeContactList - Cloud Monitor - Alibaba Cloud Documentation Center

Queries alert contacts.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageSize	integer	No	The number of entries per page. Default value: 100.	10
PageNumber	integer	No	The page number. Default value: 1.	1
ContactName	string	No	The name of the alert contact.	Alice
ChanelType	string	No	The alert notification method. Valid values: Mail: emails DingWebHook: DingTalk chatbots	Mail
ChanelValue	string	No	The value specified for the alert notification method. Note This parameter is required only if you set the `ChanelType` parameter to `Mail`.	Alice@example.com

Response elements

Element	Type	Description	Example
	object	None.
Code	string	The HTTP status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The error message returned.	The Request is not authorization.
RequestId	string	The request ID.	06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83
Total	integer	The total number of entries returned.	15
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Contacts	object
Contact	array<object>	The alert contacts.
	array<object>
UpdateTime	integer	The timestamp when the alert contact was updated. Unit: milliseconds.	1552356159000
Name	string	The name of the alert contact.	Alice
CreateTime	integer	The timestamp when the alert contact was created. Unit: milliseconds.	1552356159000
Lang	string	The language in which the alert information is displayed. Valid values: zh-cn: simplified Chinese en: English	zh-cn
Desc	string	The description.	ECS联系人
ContactGroups	object
ContactGroup	array	None.
	string	The alert contact groups.	{ "ContactGroup": [ "ECS_Group", "Jim" ] }
Channels	object	The alert notification method.
Mail	string	The email address of the alert contact.	Alice@example.com
AliIM	string	The TradeManager ID of the alert contact.	Alice
DingWebHook	string	The webhook URL of the DingTalk chatbot.	https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****
SMS	string	The phone number of the alert contac.	1333333****
ChannelsState	object	The status of the alert notification method. Valid values: PENDING and OK. The email address must be activated after it is added as the value specified for the alert notification method. The value PENDING indicates that the email address is not activated. The value OK indicates that the email address is activated.
Mail	string	The status of the email address. Valid values: PENDING: The phone number is not activated. Alert notifications can be sent to the phone number by using text messages only after the phone number is activated. OK: The phone number is activated and can receive alert notifications.	PENDING
AliIM	string	The status of the TradeManager ID. Valid value: OK. The value OK indicates that the TradeManager ID is valid and can receive alert notifications. Note This parameter applies only to the Alibaba Cloud China site (aliyun.com).	OK
DingWebHook	string	The status of the DingTalk chatbot. Valid value: OK. The value OK indicates that the DingTalk chatbot is normal and alert notifications can be received in a DingTalk group.	OK
SMS	string	The status of the phone number. Valid values: PENDING: The phone number is not activated. Alert notifications can be sent to the phone number by using text messages only after the phone number is activated. OK: The phone number is activated and can receive alert notifications. Note This parameter applies only to the Alibaba Cloud China site (aliyun.com).	OK

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83",
  "Total": 15,
  "Success": true,
  "Contacts": {
    "Contact": [
      {
        "UpdateTime": 1552356159000,
        "Name": "Alice",
        "CreateTime": 1552356159000,
        "Lang": "zh-cn",
        "Desc": "ECS联系人",
        "ContactGroups": {
          "ContactGroup": [
            "{ \"ContactGroup\": [ \t\"ECS_Group\", \"Jim\" ] }"
          ]
        },
        "Channels": {
          "Mail": "Alice@example.com",
          "AliIM": "Alice",
          "DingWebHook": "https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****",
          "SMS": "1333333****"
        },
        "ChannelsState": {
          "Mail": "PENDING",
          "AliIM": "OK",
          "DingWebHook": "OK",
          "SMS": "OK"
        }
      }
    ]
  }
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.