全部产品
Search

搜索本产品

    云监控：DescribeContactList - 查询报警联系人列表

    文档中心

    云监控：DescribeContactList - 查询报警联系人列表

    更新时间：Jul 26, 2024

    调用DescribeContactList接口查询报警联系人列表。

    调试

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

    授权信息

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

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

    请求参数

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

    每页显示的记录条数。

    默认值：100。

    		10
    PageNumberinteger否

    当前页码。

    默认值：1。

    		1
    ContactNamestring否

    报警联系人姓名。

    		Alice
    ChanelTypestring否

    报警类型。取值：

    • Mail：邮件。

    • DingWebHook：钉钉机器人。

    		Mail
    ChanelValuestring否

    报警类型的值。

    说明 仅当ChanelType设置为Mail时，需要设置该参数。
    		Alice@example.com

    返回参数

    名称类型描述示例值
    object

    无。

    Codestring

    状态码。

    说明 200 表示成功。
    		200
    Messagestring

    错误信息。

    		The Request is not authorization.
    RequestIdstring

    请求 ID。

    		06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83
    Totalinteger

    总记录条数。

    		15
    Successboolean

    操作是否成功。取值：

    • true：成功。

    • false：失败。

    		true
    Contactsarray<object>

    报警联系方式。

    object

    无。

    UpdateTimelong

    报警更新时间戳。

    单位：毫秒。

    		1552356159000
    Namestring

    报警联系人姓名。

    		Alice
    CreateTimelong

    报警创建时间戳。

    单位：毫秒。

    		1552356159000
    Langstring

    报警的语言类型。取值：

    • zh-cn：简体中文。
    • en：英文。
    		zh-cn
    Descstring

    描述信息。

    		ECS联系人
    ContactGroupsarray

    无。

    string

    报警联系人组列表。

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

    报警通知方式。

    Mailstring

    邮件地址。

    		Alice@example.com
    AliIMstring

    旺旺名称。

    		Alice
    DingWebHookstring

    钉钉机器人地址。

    		https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****
    SMSstring

    手机号码。

    		1333333****
    ChannelsStateobject

    报警通道的状态。

    因为 Email 需要激活以后才能使用，所以当添加或修改报警通道时，如果处于未激活状态，则为 PENDING；如果处于激活状态，则为 OK。

    Mailstring

    Email 的状态。取值：

    • PENDING：对应报警通道未激活，激活后才能使用。
    • OK：对应报警通道正常，可正常报警。
    		PENDING
    AliIMstring

    旺旺名称的状态正常。

    目前取值只支持：OK。OK 表示旺旺名状态正常，对应的报警通道正常，可正常报警。

    说明 该参数仅适用于中国站。
    		OK
    DingWebHookstring

    钉钉机器人的状态正常。

    目前取值只支持：OK。OK 表示钉钉机器人状态正常，对应的报警通道正常，可正常报警。

    		OK
    SMSstring

    短信的状态。取值：

    • PENDING：对应报警通道未激活，激活后才能使用。
    • OK：对应报警通道正常，可正常报警。
    说明 该参数仅适用于中国站。
    		OK

    示例

    正常返回示例

    JSON格式

    {
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83",
  "Total": 15,
  "Success": true,
  "Contacts": {
    "Contact": [
      {
        "UpdateTime": 1552356159000,
        "Name": "Alice",
        "CreateTime": 1552356159000,
        "Lang": "zh-cn",
        "Desc": "ECS联系人",
        "ContactGroups": {
          "ContactGroup": [
            "{ \"ContactGroup\": [ \t\"ECS_Group\", \"Jim\" ] }"
          ]
        },
        "Channels": {
          "Mail": "Alice@example.com",
          "AliIM": "Alice",
          "DingWebHook": "https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****",
          "SMS": "1333333****"
        },
        "ChannelsState": {
          "Mail": "PENDING",
          "AliIM": "OK",
          "DingWebHook": "OK",
          "SMS": "OK"
        }
      }
    ]
  }
}

    错误码

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

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

    变更历史

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