All Products
Search
Document Center

Application Real-Time Monitoring Service:DescribeContacts

Last Updated:May 09, 2024

Queries alert contacts.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
arms:SearchContactWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ContactNamestringNo

The name of the alert contact.

John Doe
PhonestringNo

The mobile number of the alert contact.

1381111*****
EmailstringNo

The email address of the alert contact.

someone@example.com
PagelongYes

The number of the page to return.

1
SizelongYes

The number of alert contacts to return on each page.

20
ContactIdsstringNo

The ID of the alert contact that you want to query. Separate multiple contact IDs with spaces.

123,321
VerbosestringNo

Specifies whether to return redundant information.

true
RegionIdstringNo

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

21E85B16-75A6-429A-9F65-8AAC9A54****
PageBeanobject

The objects that were returned.

Totallong

The total number of alert contacts.

1
Pagelong

The page number of the returned page.

1
Sizelong

The number of alert contacts returned per page.

20
AlertContactsobject []

The alert contacts.

ContactIdfloat

The ID of the alert contact.

123
ContactNamestring

The name of the alert contact.

John Doe
Phonestring

The mobile number of the alert contact.

1381111****
Emailstring

The email address of the alert contact.

someone@example.com
IsVerifyboolean

Indicates whether the mobile number was verified. Valid values:

  • false: no
  • true: yes
false
ReissueSendNoticelong

The operation that you want to perform if phone calls fail to be answered. Valid values:

  • 0: No operation is performed.
  • 1: A phone call is made again.
  • 2: A text message is sent.
  • 3 (default value): The global default value is used.
3
IsEmailVerifyboolean

Indicates whether the email address was verified.

true
ArmsContactIdlong

The ID of the alert contact.

100147

Examples

Sample success responses

JSONformat

{
  "RequestId": "21E85B16-75A6-429A-9F65-8AAC9A54****",
  "PageBean": {
    "Total": 1,
    "Page": 1,
    "Size": 20,
    "AlertContacts": [
      {
        "ContactId": 123,
        "ContactName": "John Doe",
        "Phone": "1381111****",
        "Email": "someone@example.com",
        "IsVerify": false,
        "ReissueSendNotice": 3,
        "IsEmailVerify": true,
        "ArmsContactId": 100147
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-04-28The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: RegionId
2022-06-24The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.