文档

DescribeContactGroupList - 查询报警联系组列表

更新时间:

调用DescribeContactGroupList接口查询报警联系组列表。

调试

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

授权信息

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

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

请求参数

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

每页显示记录条数。

1
PageNumberinteger

页码。

10

返回参数

名称类型描述示例值
object
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

错误信息。

The Request is not authorization.
RequestIdstring

请求 ID。

916EE694-03C2-47B6-85EE-5054E3C168D3
Totalinteger

总记录条数。

22
Successboolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true
ContactGroupsarray
string

报警联系组列表。

{ "ContactGroup": [ "ECS_Group", "Jim" ] }
ContactGroupListobject []

报警联系组详情列表。

Describestring

报警联系组描述信息。

PE报警组
UpdateTimelong

修改时间。Unix 时间戳:从 1970 年 1 月 1 日开始所经过的毫秒数。

1589447759000
CreateTimelong

创建时间。Unix 时间戳:从 1970 年 1 月 1 日开始所经过的毫秒数。

1507070598000
EnabledWeeklyReportboolean

是否支持周报订阅。取值:

  • true:支持。

  • false:不支持。

说明 目前仅 ECS 实例数量大于 5 的阿里云账号支持周报订阅。
true
Namestring

报警联系组的名称。

Contact1
EnableSubscribedboolean

是否开启周报订阅。

  • true:开启。

  • false:关闭。

true
Contactsarray
string

报警联系人列表。

Jimmy

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "916EE694-03C2-47B6-85EE-5054E3C168D3",
  "Total": 22,
  "Success": true,
  "ContactGroups": {
    "ContactGroup": [
      "{ \"ContactGroup\": [ \"ECS_Group\", \"Jim\" ] }"
    ]
  },
  "ContactGroupList": {
    "ContactGroup": [
      {
        "Describe": "PE报警组",
        "UpdateTime": 1589447759000,
        "CreateTime": 1507070598000,
        "EnabledWeeklyReport": true,
        "Name": "Contact1",
        "EnableSubscribed": true,
        "Contacts": {
          "Contact": [
            "Jimmy"
          ]
        }
      }
    ]
  }
}

JSON格式

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "916EE694-03C2-47B6-85EE-5054E3C168D3",
  "Total": 22,
  "Success": true,
  "ContactGroups": {
    "ContactGroup": [
      "{ \"ContactGroup\": [ \"ECS_Group\", \"Jim\" ] }"
    ]
  },
  "ContactGroupList": {
    "ContactGroup": [
      {
        "Describe": "PE报警组",
        "UpdateTime": 1589447759000,
        "CreateTime": 1507070598000,
        "EnabledWeeklyReport": true,
        "Name": "Contact1",
        "EnableSubscribed": true,
        "Contacts": {
          "Contact": [
            "Jimmy"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息
400InvalidParameter%s
403InvalidAuthorization%s
404ResourceNotFound%s
500InternalErrorThe request processing has failed due to some unknown error.

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

变更历史

变更时间变更内容概要操作
暂无变更历史