全部產品
Search

搜尋本產品

    Cloud Monitor：DescribeContactList

    文件中心

    Cloud Monitor：DescribeContactList

    更新時間：Jun 13, 2026

    呼叫 DescribeContactList 介面查詢告警聯絡人列表。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cms:DescribeContactList

    get

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    PageSize

    integer

    否

    每頁顯示的記錄條數。

    預設值：100。

    10
    PageNumber

    integer

    否

    目前頁碼。

    預設值：1。

    1
    ContactName

    string

    否

    告警聯絡人姓名。

    Alice
    ChanelType

    string

    否

    告警類型。取值：

    • Mail：郵件。

    • DingWebHook：釘釘機器人。

    Mail
    ChanelValue

    string

    否

    告警類型的值。

    說明

    僅當ChanelType設定為Mail時，需要設定該參數。

    Alice@example.com

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    無。

    Code

    string

    狀態碼。

    說明

    200 表示成功。

    200
    Message

    string

    錯誤資訊。

    The Request is not authorization.
    RequestId

    string

    請求 ID。

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

    integer

    總記錄條數。

    15
    Success

    boolean

    操作是否成功。取值：

    • true：成功。

    • false：失敗。

    true
    Contacts

    object

    Contact

    array<object>

    告警聯絡方式。

    array<object>

    無。

    UpdateTime

    integer

    警示更新時間戳記。

    單位：毫秒。

    1552356159000
    Name

    string

    警示連絡人姓名。

    Alice
    CreateTime

    integer

    警示建立時間戳記。

    單位：毫秒。

    1552356159000
    Lang

    string

    警示的語言類型。取值：

    • zh-cn：簡體中文。

    • en：英文。

    zh-cn
    Desc

    string

    描述資訊。

    ECS
    ContactGroups

    object

    ContactGroup

    array

    無。

    string

    警示連絡人群組列表。

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

    object

    警示通知方式。

    Mail

    string

    郵件地址。

    Alice@example.com
    AliIM

    string

    WangWang 名稱。

    Alice
    DingWebHook

    string

    DingTalk 機器人地址。

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

    string

    手機號碼。

    1333333****
    ChannelsState

    object

    警示通道的狀態。

    因為 Email 需要啟用以後才能使用，所以當添加或修改警示通道時，如果處於未啟用狀態，則為 PENDING；如果處於啟用狀態，則為 OK。

    Mail

    string

    Email 的狀態。取值：

    • PENDING：對應警示通道未啟用，啟用後才能使用。

    • OK：對應警示通道正常，可正常警示。

    PENDING
    AliIM

    string

    WangWang 名稱的狀態正常。

    目前取值只支援：OK。OK 表示 WangWang 名狀態正常，對應的警示通道正常，可正常警示。

    說明

    該參數僅適用於中國站。

    OK
    DingWebHook

    string

    DingTalk 機器人的狀態正常。

    目前取值只支援：OK。OK 表示 DingTalk 機器人狀態正常，對應的警示通道正常，可正常警示。

    OK
    SMS

    string

    簡訊的狀態。取值：

    • 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

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParameter %s
    500 InternalError The request processing has failed due to some unknown error.
    403 InvalidAuthorization %s
    404 ResourceNotFound %s

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。