文档

SearchAlertContactGroup - 查询报警联系人分组

更新时间:

调用SearchAlertContactGroup接口查询报警联系人分组。

接口说明

当前接口已不再维护,请使用新版告警管理的 DescribeContactGroups 接口查询告警联系人分组信息。

调试

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

授权信息

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

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

请求参数

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

报警联系人分组名称。

TestGroup
RegionIdstring

地域 ID。默认为cn-hangzhou

cn-hangzhou
ContactNamestring

报警联系人名称。

John Doe
ContactIdlong

报警联系人 ID。可调用 SearchAlertContact 接口来查询联系人 ID,请参见 SearchAlertContact

123
ContactGroupIdsstring

报警联系人分组 ID。可以同时查询多个联系人分组 ID,联系人分组 ID 之间用英文逗号(,)分隔。

746
IsDetailboolean

是否返回联系人分组中包含的所有联系人。默认不返回所有联系人。

true

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

4D6C358A-A58B-4F4B-94CE-F5AAF023****
ContactGroupsobject []

报警联系人分组信息

UpdateTimelong

更新时间的时间戳

1529668855000
ContactGroupNamestring

报警联系人分组名称

TestGroup
ContactGroupIdlong

报警联系人分组 ID

746
CreateTimelong

创建时间的时间戳

1529668855000
UserIdstring

用户 ID

113197164949****
Contactsobject []

联系人对象列表

UpdateTimelong

更新时间的时间戳

1580258717000
DingRobotstring

钉钉机器人 Webhook URL

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

联系人邮箱地址

someone@example.com
ContactIdlong

联系人 ID

123
CreateTimelong

创建时间的时间戳

1572349025000
UserIdstring

用户 ID

113197164949****
ContactNamestring

联系人名称

John Doe
SystemNocboolean

是否接收系统通知:

  • true:接收系统通知
  • false:不接收系统通知
false
Phonestring

联系人电话号码

1381111*****

示例

正常返回示例

JSON格式

{
  "RequestId": "4D6C358A-A58B-4F4B-94CE-F5AAF023****",
  "ContactGroups": [
    {
      "UpdateTime": 1529668855000,
      "ContactGroupName": "TestGroup",
      "ContactGroupId": 746,
      "CreateTime": 1529668855000,
      "UserId": "113197164949****",
      "Contacts": [
        {
          "UpdateTime": 1580258717000,
          "DingRobot": "https://oapi.dingtalk.com/robot/send?access_token=91f2f6****",
          "Email": "someone@example.com",
          "ContactId": 123,
          "CreateTime": 1572349025000,
          "UserId": "113197164949****",
          "ContactName": "John Doe",
          "SystemNoc": false,
          "Phone": "1381111*****"
        }
      ]
    }
  ]
}

错误码

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

变更历史

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