全部產品
Search

搜尋本產品

    Cloud Monitor：DescribeSiteMonitorList

    文件中心

    Cloud Monitor：DescribeSiteMonitorList

    更新時間：Jun 13, 2026

    呼叫 DescribeSiteMonitorList 介面查詢站點監控任務列表。

    介面說明

    本文將提供一個示例，查詢當前帳號的站點監控任務列表。返回結果顯示，當前帳號存在一條站點監控記錄HanZhou_ECS2。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cms:DescribeSiteMonitorList

    get

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    TaskId

    string

    否

    站點監控任務 ID。

    a1ecd34a-8157-44d9-b060-14950837****
    TaskType

    string

    否

    站點監控任務探測類型。雲端監控支援的探測類型包括：HTTP、PING、TCP、UDP、DNS、SMTP、POP3、FTP。

    HTTP
    Keyword

    string

    否

    查詢站點監控任務的關鍵字。

    說明

    支援根據任務名稱或任務地址模糊搜尋。

    site
    Page

    integer

    否

    分頁頁碼。預設值：1。

    1
    PageSize

    integer

    否

    每頁顯示條數。預設值：10。

    10
    TaskState

    string

    否

    任務狀態。取值：

    • 1：正常。

    • 2：停用。

    1
    AgentGroup

    string

    否

    任務使用的節點類型。取值：

    • PC：PC 端探測點。

    • MOBILE：行動端探測點。

    • FC：內網探測點。

    PC

    關於公共請求參數的詳情，請參見公共參數。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    無。

    RequestId

    string

    請求 ID。

    A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B
    Success

    string

    操作是否成功。取值：

    • true：成功。

    • false：失敗。

    true
    Code

    string

    狀態碼。

    說明

    200 表示成功。

    200
    Message

    string

    返回資訊。

    successful
    PageNumber

    integer

    分頁頁碼。

    1
    PageSize

    integer

    每頁顯示記錄條數。

    10
    TotalCount

    integer

    總記錄條數。

    1
    SiteMonitors

    object

    SiteMonitor

    array<object>

    站點監控任務列表。

    array<object>

    無。

    TaskType

    string

    網站監控任務探測類型。CloudMonitor 支援的探測類型包括：HTTP 、PING 、TCP 、UDP 、DNS 、SMTP 、POP3 、FTP。

    TCP
    UpdateTime

    string

    網站監控任務更新時間。

    2022-03-08 17:14:31
    Interval

    string

    探測頻率。單位：分鐘。

    1
    TaskState

    string

    任務狀態。取值：

    • 1：正常。

    • 2：禁用。

    1
    CreateTime

    string

    任務的建立時間。

    2021-11-01 11:05:18
    TaskName

    string

    網站監控任務名稱。

    New monitoring task
    Address

    string

    任務的探測 URL 地址或 IP 位址。

    https://aliyun.com
    TaskId

    string

    網站監控任務 ID。

    f5783760-1b39-4b6b-80e8-453d962a****
    OptionsJson

    object

    擴充選項。每一種探測類型有不同的擴充類型，詳情請參見 CreateSiteMonitor 。

    password

    string

    SMTP、POP3 或 FTP 探測類型的密碼。

    123****
    request_format

    string

    HTTP 要求內容格式。取值：

    • hex：十六進位格式。

    • txt：文字格式設定。

    hex
    response_content

    string

    匹配響應內容。

    • 十六進位格式：當請求的內容是位元組串，且無法用可見字元表達時，可以將位元組串轉換為十六進位表示的可見字串形式。具體轉換規則為：一個位元組轉換成二位元組的十六進位字元，例如：1 位元組（1B）轉換成十六進位為01， 27 位元組（27B）轉換成十六進位為1B。位元組（Java 形式）為{(byte)1, (byte)27}，轉換成十六進位為011b或011B。網站監控對十六進位不區分大小寫。將字串011B填入請求內容中，同時請求內容格式選擇十六進位格式。

    • 文字格式設定：普通文本指字串，即由可見字元組成的字串。

    cf0f85
    failure_rate

    number

    丟包率。

    說明

    該參數僅適用於 PING 探測類型。

    0.5
    time_out

    integer

    逾時時間。單位：毫秒。

    3000
    header

    string

    HTTP 要求頭。格式為key1:value1，通過斷行符號鍵換行。

    testKey:testValue
    cookie

    string

    發送 HTTP 要求的 Cookie 文本。

    lang=en
    port

    integer

    TCP、UDP、SMTP 或 POP3 探測類型的連接埠。

    80
    ping_num

    integer

    PING 探測的次數設定。

    20
    authentication

    integer

    是否開啟安全驗證。取值：

    • 0：開啟。

    • 1：關閉。

    1
    http_method

    string

    HTTP 的要求方法。取值：

    • get

    • post

    • head

    get
    match_rule

    integer

    是否包含警示規則。取值：

    • 0：包含。

    • 1：不包含。

    0
    dns_match_rule

    string

    DNS 的匹配規則。取值：

    • IN_DNS：期望解析的別名或 IP 位址均在 DNS 應答中。

    • DNS_IN：所有的 DNS 應答都出現在期望解析的別名或 IP 位址中。

    • EQUAL：DNS 應答和期望解析的別名或 IP 位址完全相同。

    • ANY：DNS 應答和期望解析的別名或 IP 位址有交集。

    IN_DNS
    request_content

    string

    HTTP 探測請求內容。

    cf0f85
    username

    string

    FTP、SMTP 或 POP3 的使用者名稱。

    testUser
    response_format

    string

    HTTP 響應內容格式。取值：

    • hex：十六進位格式。

    • txt：文字格式設定。

    hex
    dns_type

    string

    DNS 解析類型。僅適用於 DNS 探測類型。取值：

    • A（預設值）：指定主機名稱或網域名稱對應的 IP 位址。

    • CNAME：將多個網域名稱映射到另外一個網域名稱。

    • NS：指定網域名稱由某個 DNS 伺服器解析。

    • MX：將網域名稱指向一個郵件伺服器地址。

    • TXT：主機名稱或網域名稱的說明。文本長度限制 512 位元組，通常用做 SPF（Sender Policy Framework）記錄，即反垃圾郵件。

    • AAAA：將網域名稱解析到 IPv6 地址的 DNS 記錄。

    A
    dns_server

    string

    指定 DNS 解析伺服器的網域名稱或 IP 位址。

    192.168.XX.XX
    enable_operator_dns

    boolean

    是否使用電訊廠商的 DNS。

    • true（預設值）：使用電訊廠商的 DNS。

    • false：不使用電訊廠商的 DNS。使用預設 DNS 或指定伺服器的 DNS。

    true
    attempts

    integer

    DNS 失敗後重試次數。

    3
    protocol

    string

    DNS 探測協議類型。取值：

    • udp（預設值）

    • tcp

    • tcp-tls

    udp
    proxy_protocol

    boolean

    是否開啟 ProxyProtocol。取值：

    • false（預設值）：不開啟 ProxyProtocol。

    • true：開啟 ProxyProtocol。

    false
    acceptable_response_code

    string

    可接受的狀態代碼。

    說明

    建議您使用斷言配置。

    400
    isBase64Encode

    string

    是否對密碼進行 base64 解碼儲存。取值：

    • true：對密碼進行 base64 解碼儲存。

    • false（預設值）：不對密碼進行 base64 解碼儲存。

    false
    cert_verify

    boolean

    是否驗證認證。取值：

    • false（預設值）：忽略認證驗證。

    • true：認證驗證。

    false
    unfollow_redirect

    boolean

    如果出現 301 或 302 狀態代碼，是否跟隨再次做重新導向探測。取值：

    • true：不跟隨跳轉。

    • false（預設值）：跟隨跳轉。

    false
    diagnosis_mtr

    boolean

    是否開啟任務失敗後的自動 MTR 網路診斷。取值：

    • false（預設值）：不開啟自動 MTR 網路診斷。

    • true 開啟自動 MTR 網路診斷。

    false
    diagnosis_ping

    boolean

    是否開啟探測任務失敗後自動 Ping 網路延時探測。取值：

    • false（預設值）：不開啟。

    • true：開啟。

    false
    retry_delay

    integer

    探測失敗後重試次數。

    1
    assertions

    object

    assertions

    array<object>

    斷言配置組。

    object

    斷言配置組。

    property

    string

    斷言內容解析路徑。

    • 如果斷言類型為body_json，則路徑為json path。

    • 如果斷言類型是body_xml，則路徑為xml path。

    json path
    type

    string

    斷言類型。取值：

    • response_time：判定回應時間是否符合預期。

    • status_code：判斷 HTTP 響應狀態代碼是否符合預期。

    • header：判定響應 Header 中的欄位是否符合預期。

    • body_text：通過文本字元匹配判斷返回 Body 中的內容是否符合預期。

    • body_json：通過 JSON 解析（JSON Path）判斷返回 Body 中的內容是否符合預期。

    • body_xml：通過 XML 解析（XPath）判斷返回 Body 中的內容是否符合預期。

    response_time
    operator

    string

    斷言比較操作符。取值：

    • contains：包含。

    • doesNotContain：不包含。

    • matches：正則匹配。

    • doesNotMatch：正則不匹配。

    • is：數值等於或字元匹配相等。

    • isNot：不等於。

    • lessThan：小於。

    • moreThan：大於。

    lessThan
    target

    string

    斷言匹配比較的目標數值或字元。

    1000
    AgentGroup

    string

    探針類型。取值：

    • PC：PC 端。

    • MOBILE：移動端。

    PC

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B",
  "Success": "true",
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "SiteMonitors": {
    "SiteMonitor": [
      {
        "TaskType": "TCP",
        "UpdateTime": "2022-03-08 17:14:31",
        "Interval": "1",
        "TaskState": "1",
        "CreateTime": "2021-11-01 11:05:18",
        "TaskName": "New monitoring task",
        "Address": "https://aliyun.com",
        "TaskId": "f5783760-1b39-4b6b-80e8-453d962a****",
        "OptionsJson": {
          "password": "123****",
          "request_format": "hex",
          "response_content": "cf0f85",
          "failure_rate": 0.5,
          "time_out": 3000,
          "header": "testKey:testValue",
          "cookie": "lang=en",
          "port": 80,
          "ping_num": 20,
          "authentication": 1,
          "http_method": "get",
          "match_rule": 0,
          "dns_match_rule": "IN_DNS",
          "request_content": "cf0f85",
          "username": "testUser",
          "response_format": "hex",
          "dns_type": "A",
          "dns_server": "192.168.XX.XX",
          "enable_operator_dns": true,
          "attempts": 3,
          "protocol": "udp",
          "proxy_protocol": false,
          "acceptable_response_code": "400",
          "isBase64Encode": "false",
          "cert_verify": false,
          "unfollow_redirect": false,
          "diagnosis_mtr": false,
          "diagnosis_ping": false,
          "retry_delay": 1,
          "assertions": {
            "assertions": [
              {
                "property": "json path",
                "type": "response_time",
                "operator": "lessThan",
                "target": "1000"
              }
            ]
          }
        },
        "AgentGroup": "PC"
      }
    ]
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidQueryParameter %s
    401 AccessDeniedException You donot have sufficient access to perform this action.
    500 %s %s
    500 InternalError %s
    402 LimitExceeded The quota for this customer had been reached.
    403 Forbidden You are not authorized to operate the specified resource.
    503 %s %s
    406 ExceedingQuota Exceeding quota limits.
    429 ThrottlingException The request was denied due to request throttling.
    409 %s %s

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

    變更歷史

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