DescribeContactGroups - 查询告警联系人分组信息 - 应用实时监控服务ARMS

查询告警联系人分组信息。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
ContactGroupName	string	否	告警联系人组名称。	TestGroup
Page	long	是	查询页数。	1
Size	long	是	每页展示的联系人组数。	20
IsDetail	boolean	否	返回的联系人分组信息中是否包含所有联系人。 `fasle`（默认）：不返回所有联系人。 `true`：返回所有联系人。	true
GroupIds	string	否	联系人组 ID。	12345
RegionId	string	否	地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	4D6C358A-A58B-4F4B-94CE-F5AAF023****
PageBean	object	分页对象。
Total	long	查询到的联系人组总数。	1
Page	long	查询的页数。	1
Size	long	每页的联系人组数。	20
AlertContactGroups	array<object>	告警联系人组列表。
contactGroups	object
ContactGroupId	float	告警联系人组 ID。	123
ContactGroupName	string	告警联系人组名称。	TestGroup
Contacts	array<object>	联系人信息。IsDetail 设置为`false`时不显示 Contacts。
contacts	object
ContactId	float	联系人 ID。	456
ContactName	string	联系人姓名。	John Doe
Phone	string	联系人手机号码。	1381111****
Email	string	联系人邮箱地址。	someone@example.com
ArmsContactId	long	告警联系人 ID。	100117
ArmsContactGroupId	long	告警联系人组 ID。	83261

示例

正常返回示例

JSON格式

{
  "RequestId": "4D6C358A-A58B-4F4B-94CE-F5AAF023****",
  "PageBean": {
    "Total": 1,
    "Page": 1,
    "Size": 20,
    "AlertContactGroups": [
      {
        "ContactGroupId": 123,
        "ContactGroupName": "TestGroup",
        "Contacts": [
          {
            "ContactId": 456,
            "ContactName": "John Doe",
            "Phone": "1381111****",
            "Email": "someone@example.com",
            "ArmsContactId": 100117
          }
        ],
        "ArmsContactGroupId": 83261
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-04-28	OpenAPI 入参发生变更	查看变更详情