調用DescribeHostAvailabilityList接口查詢可用性監控任務列表。
接口說明
本文將提供一個示例,查詢當前賬號的可用性監控任務列表。返回結果顯示,當前賬號存在一條可用性監控任務記錄ecs_instance
。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cms:DescribeHostAvailabilityList | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Id | long | 否 | 單個可用性監控任務 ID。 | 123456 |
Ids | string | 否 | 多個可用性監控任務 ID。多個可用性監控任務 ID 之間用半角逗號(,)分隔。 | 123456,345678 |
TaskName | string | 否 | 可用性監控任務名稱。 | ecs_instance |
PageNumber | integer | 否 | 頁碼。 起始值:1。默認值:1。 | 1 |
PageSize | integer | 否 | 分頁時每頁顯示的數據行數。 起始值:1。默認值:10。 | 10 |
GroupId | long | 否 | 應用分組 ID。 | 12345 |
關于公共請求參數的詳情,請參見公共參數。
返回參數
示例
正常返回示例
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. | - |
403 | AccessForbidden | User not authorized to operate on the specified resource. | - |
404 | ResourceNotFound | The specified resource is not found. | 未找到指定資源。 |
500 | InternalError | The request processing has failed due to some unknown error. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史