通過DescribeHostAvailabilityList介面查詢可用性監控工作清單-CloudMonitor-阿里雲 - Cloud Monitor

查詢可用性監控任務清單。

介面說明

本文將提供一個範例，查詢目前帳號的可用性監控任務清單。返回結果顯示，目前帳號存在一條可用性監控任務記錄 ecs_instance。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cms:DescribeHostAvailabilityList

get

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
Id	integer	否	單一可用性監控任務 ID。	123456
Ids	string	否	多個可用性監控任務 ID。多個可用性監控任務 ID 之間用半形逗號（,）分隔。	123456,345678
TaskName	string	否	可用性監控任務名稱。	ecs_instance
PageNumber	integer	否	頁碼。起始值：1。預設值：1。	1
PageSize	integer	否	分頁時每頁顯示的資料列數。起始值：1。預設值：10。	10
GroupId	integer	否	應用程式分組 ID。	12345

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

返回參數

名稱	類型	描述	樣本值
	object
Code	string	狀態碼。說明 200 表示成功。	200
Message	string	錯誤訊息。	The specified resource is not found.
RequestId	string	請求 ID。	4A288E86-45C3-4858-9DB0-6D85B10BD92A
Total	integer	總記錄筆數。	1
Success	boolean	操作是否成功。取值： true：成功。 false：失敗。	true
TaskList	object
NodeTaskConfig	array<object>	可用性監控任務清單。
	array<object>	可用性監控任務清單。
TaskType	string	任務類型。取值： PING TELNET HTTP	HTTP
GroupName	string	應用分組名稱。	Group_ECS
GroupId	integer	應用分組 ID。	12345
TaskName	string	可用性監控任務名稱。	ecs_instance
Disabled	boolean	可用性監控任務是否禁用。取值： true：禁用。 false：啟用。	false
TaskScope	string	可用性監控任務的探測範圍。取值： GROUP：表示將當前應用分組內的所有 ECS 執行個體作為探測任務的探針。 GROUP_SPEC_INSTANCE：表示將當前應用分組內的指定 ECS 執行個體作為探測任務的探針。	GROUP
Id	integer	可用性監控任務 ID。	123456
Instances	object
Instance	array	發起探測的 ECS 執行個體列表。
	string	發起探測的 ECS 執行個體列表。	i-abcdefgh12****
TaskOption	object	可用性監控任務的參數選項。
HttpMethod	string	探測類型的方法。取值： GET POST HEAD	GET
Interval	integer	探測頻率。單位：秒。	60
HttpURI	string	HTTP 探測類型的探測 URI 地址。	https://www.aliyun.com
TelnetOrPingHost	string	探測的網域名稱或地址。	ssh.aliyun.com
HttpResponseCharset	string	HTTP 探測類型的響應字元集。	UTF-8
HttpPostContent	string	HTTP 探測類型探測請求的 Post 內容。	params1=paramsValue1
HttpNegative	boolean	匹配 HTTP 響應內容的警示規則。取值： true：如果 HTTP 響應內容包含設定的警示規則，則警示。 false：如果 HTTP 響應內容不包含設定的警示規則，則警示。	true
HttpKeyword	string	HTTP 探測類型匹配響應內容。	OK
AlertConfig	object	警示規則配置。
SilenceTime	integer	通道沉默時間。單位：秒。預設值：86400。	86400
EndTime	integer	警示生效的結束時間。取值範圍：0~23。例如：`AlertConfig.StartTime`為 0，`AlertConfig.EndTime`為 22，表示警示生效時間為 00:00:00 至 22:00:00。說明如果警示不在生效時間內，則超過閾值也不會發送警示通知。	22
StartTime	integer	警示生效的開始時間。取值範圍：0~23。例如：`AlertConfig.StartTime`為 0，`AlertConfig.EndTime`為 22，表示警示生效時間為 00:00:00 至 22:00:00。說明如果警示不在生效時間內，則超過閾值也不會發送警示通知。	0
WebHook	string	警示發生回調時的 URL 地址。 CloudMonitor 會將警示資訊通過 POST 請求推送到該地址，目前僅支援 HTTP 協議。	https://www.aliyun.com
NotifyType	integer	警示通知類型。取值： 2：郵件+DingTalk 機器人。 1：郵件+DingTalk 機器人。 0：郵件+DingTalk 機器人。	1
EscalationList	object
escalationList	array<object>	警示觸發條件。
	object	警示觸發條件。
Value	string	警示閾值。	400
MetricName	string	警示監控項。取值： HttpStatus：HTTP 狀態代碼。 HttpLatency：HTTP 等待時間。 TelnetStatus：TELNET 狀態代碼。 TelnetLatency：TELNET 等待時間。 PingLostRate：PING 丟包率。	HttpStatus
Operator	string	警示規則比較符號。取值： `>` `>=` `<` `<=` `=`	=
Times	string	警示周期。即連續幾個周期超過閾值。	3
Aggregate	string	警示統計方法。不同監控項的取值如下： Value：HTTP 狀態代碼的值。 Average：HTTP 等待時間的平均值。 Value：TELNET 狀態代碼的值。 TelnetLatency：TELNET 等待時間的平均值。 Average：PING 丟包率的平均值。	Value
TargetList	object
Target	array<object>	警示目標列表。
	object	警示目標列表。
Id	string	警示觸發目標 ID。	1
Arn	string	ARN 資源描述。格式：`arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`。各欄位含義如下： Service：雲端服務 Code。 Region：地區 ID。 Account：阿里雲帳號 ID。 ResourceType：資源類型。 ResourceId：資源 ID。	acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages
Level	string	警示層級。取值： INFO：資訊。 WARN：警告。 CRITICAL：緊急。	INFO
JsonParams	string	警示回調的 JSON 格式參數。	{"key1":"value1"}

樣本

正常返回樣本

JSON格式

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "4A288E86-45C3-4858-9DB0-6D85B10BD92A",
  "Total": 1,
  "Success": true,
  "TaskList": {
    "NodeTaskConfig": [
      {
        "TaskType": "HTTP",
        "GroupName": "Group_ECS",
        "GroupId": 12345,
        "TaskName": "ecs_instance",
        "Disabled": false,
        "TaskScope": "GROUP",
        "Id": 123456,
        "Instances": {
          "Instance": [
            "i-abcdefgh12****"
          ]
        },
        "TaskOption": {
          "HttpMethod": "GET",
          "Interval": 60,
          "HttpURI": "https://www.aliyun.com",
          "TelnetOrPingHost": "ssh.aliyun.com",
          "HttpResponseCharset": "UTF-8",
          "HttpPostContent": "params1=paramsValue1",
          "HttpNegative": true,
          "HttpKeyword": "OK"
        },
        "AlertConfig": {
          "SilenceTime": 86400,
          "EndTime": 22,
          "StartTime": 0,
          "WebHook": "https://www.aliyun.com",
          "NotifyType": 1,
          "EscalationList": {
            "escalationList": [
              {
                "Value": "400",
                "MetricName": "HttpStatus",
                "Operator": "=",
                "Times": "3",
                "Aggregate": "Value"
              }
            ]
          },
          "TargetList": {
            "Target": [
              {
                "Id": "1",
                "Arn": "acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages",
                "Level": "INFO",
                "JsonParams": "{\"key1\":\"value1\"}"
              }
            ]
          }
        }
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	ParameterInvalid	Illegal parameters.
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	The specified resource is not found.

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

變更歷史

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