文档

DescribeContacts - 查询告警联系人列表

更新时间:

查询告警联系人列表。

调试

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

授权信息

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

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

请求参数

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

告警联系人姓名。

John Doe
Phonestring

告警联系人手机号码。

1381111*****
Emailstring

告警联系人邮箱地址。

someone@example.com
Pagelong

查询页数。

1
Sizelong

每页展示的联系人数。

20
ContactIdsstring

需要查询的联系人 id。多个联系人 id 以空格分隔。

123,321
Verbosestring

返回冗余信息开关

true
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

分页对象。

Totallong

查询到的联系人总数。

1
Pagelong

查询的页数。

1
Sizelong

每页的联系人数。

20
AlertContactsobject []

告警联系人列表。

ContactIdfloat

告警联系人 ID。

123
ContactNamestring

告警联系人姓名。

John Doe
Phonestring

告警联系人手机号码。

1381111****
Emailstring

告警联系人邮箱地址。

someone@example.com
IsVerifyboolean

手机号码是否验证标识。

  • false:未验证。
  • true:已验证。
false
ReissueSendNoticelong

电话通知失败后,通知补发类型。

  • 0:不补发
  • 1:重复拨打一次电话
  • 2:发送短信通知
  • 3(默认):使用全局默认值
3
IsEmailVerifyboolean

邮箱是否已验证

true
ArmsContactIdlong

告警联系人 ID。

100147

示例

正常返回示例

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,
        "ReissueSendNotice": 3,
        "IsEmailVerify": true,
        "ArmsContactId": 100147
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-04-28OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:RegionId
2022-06-24OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈