獲取巡檢任務列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cmn:ListInspectionTasks | list |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MaxResults | integer | 是 | 返回結果的最大個數。 | 10 |
| NextToken | string | 否 | 當總結果個數大于 MaxResults 時，用于翻頁的 token。 | 1 |
| ItemId | string | 否 | 巡檢項 ID。 | INSPECTION_ITEM92f61d5b-1027-4984-8ff4-45976e518325 |
| HostName | string | 否 | 設備名。 | ASW-S-3F1-1.CD1 |
| IP | string | 否 | 設備 IP。 | 127.0.0.1 |
| TaskStatus | string | 否 | 巡檢任務狀態。 枚舉值：
| SUCCESS |
| InstanceId | string | 是 | 實例 ID。 | cmn-cn-xxx |
| Space | string | 否 | 物理空間。 | XX門店 |
| Role | string | 否 | 設備角色。 | ASW |
| Vendor | string | 否 | 設備廠商。 | Alibaba |
| Model | string | 否 | 設備型號。 | SAG-100WM |
| DeviceType | string | 否 | 設備類型。 | NETWORK |
| AlarmStatus | array | 否 | 告警狀態列表。 | |
| string | 否 | 告警狀態。
| CRITICAL |
返回參數
示例
正常返回示例
JSON格式
{
"TotalCount": 10,
"RequestId": "AC8F05E6-AFBB-4ABE-B75E-A6539A9BAAA8",
"NextToken": 0,
"InspectionTasks": [
{
"DeviceId": "device-sss75gb7atel59si",
"ItemId": "INSPECTION_ITEMe760d72a-756f-4a2b-8a8b-e12f51b51a3f",
"ExecutionEndTime": "2020-12-23 10:01:05",
"ExecutionBeginTime": "2020-12-23 10:01:05",
"ItemName": "config_back",
"ScriptId": "INSPECTION_TEMPLATE0ae638e1-8420-4c2a-8095-8a4f5929a2df",
"Space": "XX門店",
"InspectionAlarmRules": [
{
"AlarmExpression": "TelnetStatus != SUCCESS",
"AlarmOperator": "AND",
"AlarmValue": "SUCCESS",
"ActualValue": "FAILURE",
"AlarmLevel": "WARNING"
}
],
"IP": "127.0.0.1",
"HostName": "localhost",
"Vendor": "Alibaba",
"TaskStatus": "SUCCESS",
"Model": [
"SAG-100WM"
],
"ErrorCode": "AGENT_LOGIN_FAIL",
"InspectionMessage": "error: Telnet Login failed",
"TaskId": "INSPECTION_TASK9b094655-3c55-443f-bf57-65ede230def4",
"Role": "ASW",
"InspectionResult": "{}",
"IsInspectionResultTruncation": true,
"DeviceType": "NETWORK",
"AlarmStatus": "WARNING"
}
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 |
|---|---|---|
| 400 | SignatureDoesNotMatch | 簽名不通過 |
| 403 | NoPermission | 沒有權限 |
| 404 | ServiceNotFound | 后端服務未找到 |
| 500 | InternalError | 服務器內部錯誤 |
| 503 | ServiceUnavailable | 服務不可用 |
訪問錯誤中心查看更多錯誤碼。