调用SearchAlertContact接口查询报警联系人。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | SearchAlertContact |
系统规定参数。取值:SearchAlertContact。 |
ContactName | String | 否 | John Doe |
报警联系人名称。 |
Phone | String | 否 | 1381111***** |
报警联系人电话号码。 |
String | 否 | someone@example.com |
联系人邮箱地址。 |
|
CurrentPage | String | 否 | 1 |
查询分页的当前页码。 |
PageSize | String | 否 | 20 |
查询分页的每页项目数量。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。始终填写 |
ContactIds | String | 否 | [12345] |
报警联系人ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 21E85B16-75A6-429A-9F65-8AAC9A54**** |
请求ID。 |
PageBean | Object |
返回结构体。 |
|
PageNumber | Integer | 1 |
返回结果的页码。 |
PageSize | Integer | 10 |
返回结果的每页项目数量。 |
TotalCount | Integer | 23 |
返回结果的总项数数量。 |
Contacts | Array of Contact |
联系人对象列表。 |
|
UpdateTime | Long | 1580258717000 |
更新时间的时间戳。 |
DingRobot | String | https://oapi.dingtalk.com/robot/send?access_token=91f2f6**** |
钉钉机器人Webhook URL。 |
Webhook | String | {\"body\":\"{ \\\"msg_type\\\": \\\"text\\\", \\\"content\\\": { \\\"text\\\": \\\"$content\\\" } }\",\"header\":{\"Arms-Content-Type\":\"json\"},\"method\":\"post\",\"params\":{},\"url\":\"https://***",\"userId\":\"1131971649***\"}", |
Webhook信息。 |
String | someone@example.com |
联系人邮箱地址。 |
|
ContactId | Long | 123 |
联系人ID。 |
CreateTime | Long | 1572349025000 |
创建时间的时间戳。 |
UserId | String | 113197164949**** |
用户ID。 |
ContactName | String | John Doe |
联系人名称。 |
SystemNoc | Boolean | false |
是否接收系统通知:
|
Content | String | 默认分组|SRE分组 |
联系人所在的联系人组。如果联系人被添加至多个联系人组中,则多个联系人组之间会使用竖线(|)分隔。 |
Phone | String | 1381111***** |
联系人电话号码。 |
示例
请求示例
http(s)://[Endpoint]/?Action=SearchAlertContact
&ContactName=John Doe
&Phone=1381111*****
&Email=someone@example.com
&CurrentPage=1
&PageSize=20
&RegionId=cn-hangzhou
&ContactIds=[12345]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<SearchAlertContactResponse>
<RequestId>21E85B16-75A6-429A-9F65-8AAC9A54****</RequestId>
<PageBean>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>23</TotalCount>
<Contacts>
<UpdateTime>1580258717000</UpdateTime>
<DingRobot>https://oapi.dingtalk.com/robot/send?access_token=91f2f6****</DingRobot>
<Webhook>{\"body\":\"{ \\\"msg_type\\\": \\\"text\\\", \\\"content\\\": { \\\"text\\\": \\\"$content\\\" } }\",\"header\":{\"Arms-Content-Type\":\"json\"},\"method\":\"post\",\"params\":{},\"url\":\"https://***",\"userId\":\"1131971649***\"}",</Webhook>
<Email>someone@example.com</Email>
<ContactId>123</ContactId>
<CreateTime>1572349025000</CreateTime>
<UserId>113197164949****</UserId>
<ContactName>John Doe</ContactName>
<SystemNoc>false</SystemNoc>
<Content>默认分组|SRE分组</Content>
<Phone>1381111*****</Phone>
</Contacts>
</PageBean>
</SearchAlertContactResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "21E85B16-75A6-429A-9F65-8AAC9A54****",
"PageBean" : {
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 23,
"Contacts" : {
"UpdateTime" : 1580258717000,
"DingRobot" : "https://oapi.dingtalk.com/robot/send?access_token=91f2f6****",
"Webhook" : "{\\\"body\\\":\\\"{ \\\\\\\"msg_type\\\\\\\": \\\\\\\"text\\\\\\\", \\\\\\\"content\\\\\\\": { \\\\\\\"text\\\\\\\": \\\\\\\"$content\\\\\\\" } }\\\",\\\"header\\\":{\\\"Arms-Content-Type\\\":\\\"json\\\"},\\\"method\\\":\\\"post\\\",\\\"params\\\":{},\\\"url\\\":\\\"https://***\",\\\"userId\\\":\\\"1131971649***\\\"}\",",
"Email" : "someone@example.com",
"ContactId" : 123,
"CreateTime" : 1572349025000,
"UserId" : "113197164949****",
"ContactName" : "John Doe",
"SystemNoc" : false,
"Content" : "默认分组|SRE分组",
"Phone" : "1381111*****"
}
}
}