DescribeContacts - API参考| 阿里云

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	DescribeContacts	系统规定参数。取值：DescribeContacts。
ContactName	String	否	John Doe	告警联系人姓名。
Phone	String	否	1381111*****	告警联系人手机号码。
Email	String	否	someone@example.com	告警联系人邮箱地址。
Page	Long	是	1	查询页数。
Size	Long	是	20	每页展示的联系人数。

返回数据


名称	类型	示例值	描述
RequestId	String	21E85B16-75A6-429A-9F65-8AAC9A54****	请求ID。
PageBean	Object		分页对象。
Total	Long	1	查询到的联系人总数。
Page	Long	1	查询的页数。
Size	Long	20	每页的联系人数。
AlertContacts	Array of contacts		告警联系人列表。
ContactId	Float	123	告警联系人ID。
ContactName	String	John Doe	告警联系人姓名。
Phone	String	1381111****	告警联系人手机号码。
Email	String	someone@example.com	告警联系人邮箱地址。
IsVerify	Boolean	false	手机号码是否验证标识。 `fasle`：未验证。 `true`：已验证。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeContacts
&ContactName=John Doe
&Phone=1381111*****
&Email=someone@example.com
&Page=1
&Size=20
&公共请求参数

正常返回示例

XML格式

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

<DescribeContactsResponse>
    <RequestId>21E85B16-75A6-429A-9F65-8AAC9A54****</RequestId>
    <PageBean>
        <Total>1</Total>
        <Page>1</Page>
        <Size>20</Size>
        <AlertContacts>
            <ContactId>123</ContactId>
            <ContactName>John Doe</ContactName>
            <Phone>1381111****</Phone>
            <Email>someone@example.com</Email>
            <IsVerify>false</IsVerify>
        </AlertContacts>
    </PageBean>
</DescribeContactsResponse>

JSON格式

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

{
  "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
    } ]
  }
}