全部產品
Search

搜尋本產品

    Cloud Monitor：CreateHostAvailability

    文件中心

    Cloud Monitor：CreateHostAvailability

    更新時間：Jul 10, 2026

    建立可用性監控任務。

    介面說明

    本文將提供一個範例，在應用程式分組123456中建立偵測類型為HTTP的可用性監控任務task1，透過電子郵件和 DingTalk 機器人向您發送警示通知。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cms:CreateHostAvailability

    create

    *HostAvailability

    acs:cms::{#accountId}:group/{#groupId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    GroupId

    integer

    是

    應用程式分組 ID。

    123456
    TaskName

    string

    是

    可用性監控任務名稱。取值範圍：4~100 個字元，支援英文字母、數字、底線（_）和漢字。

    task1
    TaskScope

    string

    否

    可用性監控任務的偵測範圍。取值：

    • GROUP：表示將目前應用程式分組內的所有 ECS 執行個體作為偵測任務的探針。

    • GROUP_SPEC_INSTANCE：表示將目前應用程式分組內的指定 ECS 執行個體作為偵測任務的探針。設定此參數時，需要同時設定 InstanceList（發起偵測的 ECS 執行個體清單）。

    GROUP
    TaskType

    string

    是

    可用性監控任務的偵測類型。取值：

    • PING

    • TELNET

    • HTTP

    HTTP
    TaskOption.HttpURI

    string

    否

    HTTP、Telnet 偵測類型的偵測 URI 位址。

    https://www.aliyun.com telnet://127.0.0.1:80
    TaskOption.TelnetOrPingHost

    string

    否

    偵測的網域或位址。

    說明

    如果偵測任務類型為 PING，則需要設定此參數。

    www.aliyun.com
    TaskOption.HttpResponseCharset

    string

    否

    HTTP 偵測類型的回應字元集。

    說明

    僅支援 UTF-8。

    UTF-8
    TaskOption.HttpPostContent

    string

    否

    HTTP 偵測類型偵測請求的 Post 內容。

    params1=paramsValue1
    TaskOption.HttpResponseMatchContent

    string

    否

    比對回應的內容。

    ok
    TaskOption.HttpMethod

    string

    否

    偵測類型的方法。取值：

    • GET

    • POST

    • HEAD

    說明

    如果任務的偵測類型為 HTTP，則需要設定此參數。

    GET
    TaskOption.HttpNegative

    boolean

    否

    比對 HTTP 回應內容的警示規則。取值：

    • true：如果 HTTP 回應內容包含設定的警示規則，則發出警示。

    • false：如果 HTTP 回應內容不包含設定的警示規則，則發出警示。

    說明

    如果任務的偵測類型為 HTTP，則此參數生效。

    true
    TaskOption.HttpHeader

    string

    否

    HTTP 請求的 Header。格式為參數名:參數，多個參數之間用換行符號分隔，例如：

    params1:value1
params2:value2

    token:testTokenValue
    TaskOption.Interval

    integer

    否

    偵測頻率。單位：秒。取值：15、30、60、120、300、900、1800 和 3600。

    說明

    僅 3.5.1 及以上版本的雲端監控外掛程式支援此參數。

    60
    AlertConfig.NotifyType

    integer

    是

    警示通知類型。取值：

    0：電子郵件+DingTalk 機器人。

    0
    AlertConfig.StartTime

    integer

    否

    警示生效的開始時間。取值範圍：0~23。

    例如：AlertConfig.StartTime為 0，AlertConfig.EndTime為 22，表示警示生效時間為 00:00:00 至 22:00:00。

    說明

    如果警示不在生效時間內，則超過閾值也不會發送警示通知。

    0
    AlertConfig.EndTime

    integer

    否

    警示生效的結束時間。取值範圍：0~23。

    例如：AlertConfig.StartTime為 0，AlertConfig.EndTime為 22，表示警示生效時間為 00:00:00 至 22:00:00。

    說明

    如果警示不在生效時間內，則超過閾值也不會發送警示通知。

    22
    AlertConfig.SilenceTime

    integer

    否

    通道靜默時間。單位：秒，預設值：86400（1 天）。

    86400
    AlertConfig.WebHook

    string

    否

    URL 回呼位址。

    https://www.aliyun.com/webhook.json
    AlertConfigEscalationList

    array<object>

    是

    無。

    object

    否

    無。

    MetricName

    string

    是

    警示的監控項目。N 的取值範圍：1~21。取值：

    • HttpStatus：HTTP 狀態碼。

    • HttpLatency：HTTP 等待時間。

    • TelnetStatus：Telnet 狀態碼。

    • TelnetLatency：Telnet 等待時間。

    • PingLostRate：Ping 封包遺失率。

    HttpStatus
    Value

    string

    否

    警示閾值。N 的取值範圍：1~21。

    90
    Times

    integer

    否

    警示重試次數。N 的取值範圍：1~21。

    3
    Operator

    string

    否

    警示規則比較符號。N 的取值範圍：1~21。取值：

    • >

    • >=

    • <

    • <=

    • =

    >
    Aggregate

    string

    否

    警示統計方法。N 的取值範圍：1~21。不同監控項目的取值如下：

    • HttpStatus：Value。

    • HttpLatency：Average。

    • TelnetStatus：Value。

    • TelnetLatency：Average。

    • PingLostRate：Average。

    說明

    狀態碼類的統計方法為原始值（Value），延遲時間或封包遺失率的統計方法為平均值（Average）。

    Value
    InstanceList

    array

    否

    發起偵測的 ECS 執行個體清單。N 的取值範圍：1~21。

    說明

    當TaskScope為GROUP_SPEC_INSTANCE時，需要設定此參數。

    i-absdfkwl321****

    string

    否

    發起偵測的 ECS 執行個體清單。N 的取值範圍：1~21。

    說明

    當TaskScope為GROUP_SPEC_INSTANCE時，需要設定此參數。

    2
    AlertConfigTargetList

    array<object>

    否

    警示觸發目標。

    object

    否

    警示觸發目標。

    Id

    string

    否

    警示觸發目標 ID。

    1
    Arn

    string

    否

    資源 ARN。格式為acs:{雲端產品縮寫}:{regionId}:{userId}:/{資源類型}/{資源名稱}/message。例如：acs:mns:cn-hangzhou:120886317861****:/queues/test123/message。參數說明如下：

    • {雲端產品縮寫}：目前僅支援輕量訊息佇列（原 MNS）。

    • {userId}：阿里雲帳號 ID。

    • {regionId}：輕量訊息佇列（原 MNS）或主題所在地域。

    • {資源類型}`：接收警示的資源類型。取值：

      • queues：佇列。

      • topics：主題。

    • {資源名稱}：資源名稱。

      • 如果資源類型為 queues，則資源名稱為佇列名稱。

      • 如果資源類型為 topics，則資源名稱為主題名稱。

    acs:mns:cn-hangzhou:120886317861****:/queues/test/message
    Level

    string

    否

    警示層級。取值：

    • INFO：資訊。

    • WARN：警告。

    • CRITICAL：緊急。

    ["INFO", "WARN", "CRITICAL"]
    JsonParams

    string

    否

    警示回呼的 JSON 格式參數。

    {"customField1":"value1","customField2":"$.name"}

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

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Code

    string

    狀態碼。

    說明

    200 表示成功。

    200
    Message

    string

    錯誤資訊。

    The specified resource is not found.
    RequestId

    string

    請求 ID。

    ACBDBB40-DFB6-4F4C-8957-51FFB233969C
    TaskId

    integer

    可用性監控任務 ID。

    12345
    Success

    boolean

    操作是否成功。取值：

    • true：成功。

    • false：失敗。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "ACBDBB40-DFB6-4F4C-8957-51FFB233969C",
  "TaskId": 12345,
  "Success": true
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 ParameterInvalid Parameter invalid. 非法參數。
    412 ResouceOverLimit The task over limit
    500 InternalError The request processing has failed due to some unknown error.
    403 AccessForbidden User not authorized to operate on the specified resource.
    404 ResourceNotFound %s
    409 ResourceConflict Concurrent modification of resources.
    409 ResourceExist Resources already exist.

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

    變更歷史

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