文档

SearchAlertContact - 查询报警联系人

更新时间:

调用SearchAlertContact接口查询报警联系人。

接口说明

当前接口已不再维护,请使用新版告警管理的 DescribeContacts 接口查询告警联系人列表。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
arms:SearchAlertContactWrite
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ContactNamestring

报警联系人名称。

John Doe
Phonestring

报警联系人电话号码。

1381111*****
Emailstring

联系人邮箱地址。

someone@example.com
CurrentPagestring

查询分页的当前页码。

1
PageSizestring

查询分页的每页项目数量。

20
RegionIdstring

地域 ID。始终填写cn-hangzhou

cn-hangzhou
ContactIdsstring

报警联系人 ID。

[12345]

返回参数

名称类型描述示例值
object

响应对象。

RequestIdstring

请求 ID。

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

返回结构体。

PageNumberinteger

返回结果的页码。

1
PageSizeinteger

返回结果的每页项目数量。

10
TotalCountinteger

返回结果的总项数数量。

23
Contactsobject []

联系人对象列表。

UpdateTimelong

更新时间的时间戳。

1580258717000
DingRobotstring

钉钉机器人 Webhook URL。

https://oapi.dingtalk.com/robot/send?access_token=91f2f6****
Webhookstring

Webhook 信息。

{\"body\":\"{ \\\"msg_type\\\": \\\"text\\\", \\\"content\\\": { \\\"text\\\": \\\"$content\\\" } }\",\"header\":{\"Arms-Content-Type\":\"json\"},\"method\":\"post\",\"params\":{},\"url\":\"https://***",\"userId\":\"1131971649***\"}",
Emailstring

联系人邮箱地址。

someone@example.com
ContactIdlong

联系人 ID。

123
CreateTimelong

创建时间的时间戳。

1572349025000
UserIdstring

用户 ID。

113197164949****
ContactNamestring

联系人名称。

John Doe
SystemNocboolean

是否接收系统通知:

  • true:接收系统通知。
  • false:不接收系统通知。
false
Contentstring

联系人所在的联系人组。如果联系人被添加至多个联系人组中,则多个联系人组之间会使用竖线(|)分隔。

默认分组|SRE分组
Phonestring

联系人电话号码。

1381111*****
ResourceGroupIdstring

资源组 ID。

rg-acfmxyexli2****

示例

正常返回示例

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*****",
        "ResourceGroupId": "rg-acfmxyexli2****"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈