全部產品
Search

搜尋本產品

    Cloud Monitor：CreateInstantSiteMonitor

    文件中心

    Cloud Monitor：CreateInstantSiteMonitor

    更新時間：Jul 09, 2026

    建立一次性探測任務。

    介面說明

    僅開通網路分析與監控的阿里雲帳號，才能建立一次性探測任務。

    本文將提供一個範例，建立一次性探測任務，該探測任務的名稱為 task1，探測位址為 http://www.aliyun.com，探測類型為 HTTP，探測點數量為 1。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cms:CreateInstantSiteMonitor

    create

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Address

    string

    是

    探測任務的 URL 或 IP 位址。

    http://www.aliyun.com
    TaskType

    string

    是

    探測任務的類型。 目前探測任務的類型包括：HTTP、PING、TCP、UDP 和 DNS。

    HTTP
    TaskName

    string

    是

    探測任務的名稱。

    長度 4~100 個字元，取值可包含英文字母、數字和底線（_）。

    task1
    IspCities

    string

    否

    探測點資訊。如果該參數取值為空，則系統隨機選擇 3 個探測點。

    格式為 JSONArray，例如：[{"city":"546","isp":"465", "type":"IDC"},{"city":"572","isp":"465", "type":"LASTMILE"},{"city":"738","isp":"465"}]，分別對應北京、杭州、青島。

    type 指示撥測點類型。當 AgentGroup 為 PC 時，可選值為 IDC 和 LASTMILE。IDC 指的是部署在資料中心的撥測點，LASTMILE 指的是部署在使用者家中，使用固網的撥測點。type 為非必填選項，預設值為 IDC。當 AgentGroup 為 MOBILE 時，無需填寫。

    關於如何獲取探測點資訊，請參見 DescribeSiteMonitorISPCityList 。

    說明

    IspCities 和 RandomIspCity 必須二擇一。

    [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]
    OptionsJson

    string

    否

    探測任務對應通訊協定類型的進階擴充選項。不同探測任務的通訊協定類型對應不同的擴充選項。

    {"time_out":5000}
    RandomIspCity

    integer

    否

    探測點的數量。

    說明

    • IspCities 和 RandomIspCity 必須二擇一。- 如果您設定了參數 RandomIspCity，參數 IspCities 自動失效。

    1
    AgentGroup

    string

    否

    探測點類型，可選值為 PC 和 MOBILE。PC 為固網探測點，MOBILE 為行動裝置端探測點。預設值為 PC。

    PC

    TaskType 的進階參數說明

    TaskType 中 HTTP、PING、TCP、UDP 和 DNS 的進階參數設定方法如下表所示。

    • HTTP

    參數類型描述
    http_methodStringHTTP 請求方式。支援三種請求方式：GET、POST、HEAD。預設值：GET。
    headerString換行符號（\n）分隔的自訂 HTTP header。
    每行 Header 格式需符合 HTTP 通訊協定（使用半形冒號分隔的鍵值）。
    cookieStringCookie 和 HTTP 請求標準的寫法一致。
    request_contentString請求內容。支援兩種格式：JSON 和表單。不提供時，請求中不含內文。
    response_contentString預期的回應內容。探測時會檢查 HTTP 伺服器返回的前 64 個位元組。
    match_ruleString0：回應中不含 response_content 時，探測成功。
    1：回應中含 response_content 時，探測成功。
    usernameString如果提供使用者名稱，則會在 HTTP 請求中攜帶 BasicAuth header。
    passwordStringHTTP 請求驗證密碼。
    time_outint逾時時間。單位：毫秒。預設值：30000。
    max_redirectint最大重新導向次數。ECS 探針預設 5 次，營運商探針預設 2 次。
    如果需要禁止重新導向，則將該參數設定為 0。
    取值範圍：0~50 。

    • PING

    參數類型描述
    failure_rateint當 PING 失敗率超過該參數時，探測失敗，返回 610（PingAllFail）或 615（PingPartialFail）。
    預設值：0.1。
    ping_numintPING 次數，預設值：20。
    取值範圍：1~100。

    • TCP 或 UDP

    參數類型描述
    portintTCP 或 UDP 伺服器的連接埠。
    request_contentstring請求內容。當 request_format 為 hex 時，request_content 內容為十六進位緊湊格式。
    request_formatstring當 request_format 為其他值時，request_content 作為普通字串傳送給 TCP 或 UDP 伺服器。
    response_contentstring回應內容。當 TCP 或 UDP 伺服器返回的內容中不含 response_content 時，探測失敗。
    當 response_format 為 hex 時，response_content 中的內容為十六進位緊湊格式。
    當 response_content 為其他值時，response_content 為普通字串。

    • DNS

    參數類型描述
    dns_serverstringDNS 伺服器位址，可以為網域或 IP 位址。
    dns_typestringDNS 查詢類型。取值：A、NS、CNAME、MX、TXT、ANY。
    expect_valuestring英文空白符號分隔的預期值清單。
    match_rulestring預期值清單與 DNS 清單的關係，當不滿足指定關係時，探測失敗。
    空字串或 IN_DNS：預期值清單是 DNS 清單的子集。
    DNS_IN：DNS 清單是預期值清單的子集。
    EQUAL：DNS 清單與預期值清單相等。
    ANY：DNS 清單與預期值清單有交集（交集不為空）。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Code

    string

    狀態碼。

    說明

    200 表示成功。

    200
    Message

    string

    返回資訊。

    successful
    RequestId

    string

    請求 ID。

    68192f5d-0d45-4b98-9724-892813f86c71
    Success

    string

    操作是否成功。取值：

    • true：成功。

    • false：失敗。

    true
    CreateResultList

    array<object>

    建立一次性探測任務的結果清單。

    object

    建立一次性探測任務的結果清單。

    TaskId

    string

    探測任務 ID。

    2c8dbdf9-a3ab-46a1-85a4-f094965e****
    TaskName

    string

    探測任務名稱。

    task1

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "68192f5d-0d45-4b98-9724-892813f86c71",
  "Success": "true",
  "CreateResultList": [
    {
      "TaskId": "2c8dbdf9-a3ab-46a1-85a4-f094965e****",
      "TaskName": "task1"
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidQueryParameter %s
    400 IllegalAddress Illegal HTTP address
    400 OperationError Operation failed
    400 TaskNotExists Task does not exist
    400 OperatorInvalid Operator invalid
    400 OperatorCityInvalid Operator City invalid
    400 NameRepeat Task name repeat
    400 CreateAlarmError Create alarm error
    400 NameNotExists Task name not exists
    400 Illegal Task Name The task name of the sitemonitor task is illegal.
    401 AccessDeniedException You donot have sufficient access to perform this action.
    500 InternalError %s
    402 LimitExceeded The quota for this customer had been reached.
    403 %s %s
    403 Forbidden %s
    503 %s %s
    406 ExceedingQuota Exceeding quota limits.
    409 %s %s

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

    變更歷史

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