Queries alert contacts.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeContactList

The operation that you want to perform. Set the value to DescribeContactList.

PageSize Integer No 10

The number of entries to return on each page.

Default value: 100.

PageNumber Integer No 1

The number of the page to return.

Default value: 1.

ContactName String No Alice

The name of the alert contact.

ChanelType String No Mail

The alert notification method. Valid values:

  • Mail: emails
  • DingWebHook: DingTalk chatbots
ChanelValue String No Alice@example.com

The value specified for the alert notification method.

Note This parameter is required only if you set the ChanelType parameter to Mail.

Response parameters

Parameter Type Example Description
Code String 200

The HTTP status code.

Note The status code 200 indicates that the call was successful.
Message String The Request is not authorization.

The error message.

RequestId String 06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83

The ID of the request.

Total Integer 15

The total number of returned entries.

Success Boolean true

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
Contacts Array of Contact

The alert contacts.

Contact
UpdateTime Long 1552356159000

The timestamp when the alert contact was updated.

Unit: milliseconds.

Name String Alice

The name of the alert contact.

CreateTime Long 1552356159000

The timestamp when the alert contact was created.

Unit: milliseconds.

Lang String zh-cn

The language in which the alert information is displayed. Valid values:

  • zh-cn: simplified Chinese
  • en: English
Desc String ECS alert contact

The description of the alert contact.

ContactGroups Array of String { "ContactGroup": [ "ECS_Group", "Jim" ] }

The alert contact groups.

Channels Object

The alert notification method.

Mail String Alice@example.com

The email address of the alert contact.

AliIM String Alice

The TradeManager ID of the alert contact.

DingWebHook String https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****

The webhook URL of the DingTalk chatbot.

SMS String 1333333****

The phone number of the alert contact.

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 PENDING

The status of the email address. Valid values:

  • PENDING: The email address is not activated. Alert notifications can be sent to the email address only after the email address is activated.
  • OK: The email address is activated and can receive alert notifications.
AliIM String OK

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 can be returned only on the China site (aliyun.com).
DingWebHook String OK

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.

SMS String OK

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 can be returned only on the China site (aliyun.com).

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeContactList
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeContactListResponse>
		<RequestId>A1267F27-942F-40EE-9254-57FE16E3C9AB</RequestId>
		<Contacts>
			<Contact>
				<Desc>Contact Desc</Desc>
				<ContactGroups>
					<ContactGroup>ECS_Group</ContactGroup>
					<ContactGroup>Jim</ContactGroup>
				</ContactGroups>
				<ChannelsState>
					<SMS>PENDING</SMS>
					<Mail>OK</Mail>
				</ChannelsState>
				<CreateTime>1583307692000</CreateTime>
				<UpdateTime>1589441072000</UpdateTime>
				<Channels>
					<Mail>alice@example.com</Mail>
					<SMS>155*******</SMS>
				</Channels>
				<Name>Alice</Name>
				<Lang>zh-cn</Lang>
			</Contact>
		</Contacts>
		<Total>25</Total>
		<Code>200</Code>
		<Success>true</Success>
</DescribeContactListResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A1267F27-942F-40EE-9254-57FE16E3C9AB",
  "Contacts" : {
    "Contact" : [ {
      "Desc" : "Contact Desc",
      "ContactGroups" : {
        "ContactGroup" : [ "ECS_Group", "Jim" ]
      },
      "ChannelsState" : {
        "SMS" : "PENDING",
        "Mail" : "OK"
      },
      "CreateTime" : 1583307692000,
      "UpdateTime" : 1589441072000,
      "Channels" : {
        "Mail" : "alice@example.com",
        "SMS" : "155*******"
      },
      "Name" : "Alice",
      "Lang" : "zh-cn"
    } ]
  },
  "Total" : 25,
  "Code" : "200",
  "Success" : true
}

Error codes

For a list of error codes, visit the API Error Center.