DescribeContacts - 查询告警联系人列表 - 应用实时监控服务ARMS

查询告警联系人列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
arms:SearchContact	none	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
ContactName	string	否	告警联系人姓名。	John Doe
Phone	string	否	告警联系人手机号码。	1381111*****
Email	string	否	告警联系人邮箱地址。	someone@example.com
Page	long	是	查询页数。	1
Size	long	是	每页展示的联系人数。	20
ContactIds	string	否	需要查询的联系人 id。多个联系人 id 以空格分隔。	123,321
Verbose	string	否	返回冗余信息开关	true
RegionId	string	否	地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	21E85B16-75A6-429A-9F65-8AAC9A54****
PageBean	object	分页对象。
Total	long	查询到的联系人总数。	1
Page	long	查询的页数。	1
Size	long	每页的联系人数。	20
AlertContacts	array<object>	告警联系人列表。
contacts	object
ContactId	float	告警联系人 ID。	123
ContactName	string	告警联系人姓名。	John Doe
Phone	string	告警联系人手机号码。	1381111****
Email	string	告警联系人邮箱地址。	someone@example.com
IsVerify	boolean	手机号码是否验证标识。 `false`：未验证。 `true`：已验证。	false
ReissueSendNotice	long	电话通知失败后，通知补发类型。 0：不补发 1：重复拨打一次电话 2：发送短信通知 3（默认）：使用全局默认值	3
IsEmailVerify	boolean	邮箱是否已验证	true
ArmsContactId	long	告警联系人 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-28	OpenAPI 入参发生变更	查看变更详情
2022-06-24	OpenAPI 返回结构发生变更	查看变更详情