調用DescribeSiteMonitorList接口查詢站點監控任務列表。
接口說明
本文將提供一個示例，查詢當前賬號的站點監控任務列表。返回結果顯示，當前賬號存在一條站點監控記錄HanZhou_ECS2。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cms:DescribeSiteMonitorList | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 |
關于公共請求參數的詳情，請參見公共參數。
返回參數
示例
正常返回示例
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": "新的探測任務",
"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. | - |
| 402 | LimitExceeded | The quota for this customer had been reached. | - |
| 403 | Forbidden | You are not authorized to operate the specified resource. | 沒有權限，請使用RAM進行授權 |
| 406 | ExceedingQuota | Exceeding quota limits. | - |
| 409 | %s | %s | - |
| 429 | ThrottlingException | The request was denied due to request throttling. | - |
| 500 | InternalError | %s | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-05-22 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2021-09-16 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |