调用ListInspectionTasks获取巡检任务列表_云网管(CMN)-阿里云帮助中心

获取巡检任务列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cmn:ListInspectionTasks	list	InspectionTask acs:cmn:{#regionId}:{#accountId}:inspectiontask/*	无	无

请求参数

名称	类型	必填	描述	示例值
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：SUCCESS。 RUNNING：RUNNING。 TIMEOUT：TIMEOUT。 FAILURE：FAILURE。	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：严重。 WARNING：警告。	CRITICAL

返回参数

名称	类型	描述	示例值
	object	Schema of Response
TotalCount	integer	总记录数。	10
RequestId	string	请求 ID。	AC8F05E6-AFBB-4ABE-B75E-A6539A9BAAA8
NextToken	integer	当总结果个数大于 MaxResults 时，用于翻页的 token。	""或"1"
InspectionTasks	array<object>	数组，返回示例目录。
	object	巡检任务对象。
DeviceId	string	设备 ID。	device-sss75gb7atel59si
ItemId	string	巡检项 ID。	INSPECTION_ITEMe760d72a-756f-4a2b-8a8b-e12f51b51a3f
ExecutionEndTime	string	巡检结束时间。	2020-12-23 10:01:05
ExecutionBeginTime	string	巡检开始时间。	2020-12-23 10:01:05
ItemName	string	巡检项名字。	config_back
ScriptId	string	模板 ID。	INSPECTION_TEMPLATE0ae638e1-8420-4c2a-8095-8a4f5929a2df
Space	string	物理空间。	XX门店
InspectionAlarmRules	array<object>	告警规则列表。
	object	告警规则对象。
AlarmExpression	string	告警表达式。	TelnetStatus != SUCCESS
AlarmOperator	string	运算符。	AND
AlarmValue	string	告警值。	SUCCESS
ActualValue	string	告警实际值。	FAILURE
AlarmLevel	string	告警级别。 CRITICAL：严重。 WARNING：警告。	WARNING
IP	string	IP 地址。	127.0.0.1
HostName	string	设备名。	localhost
Vendor	string	厂商。	Alibaba
TaskStatus	string	任务状态。 SUCCESS：成功。 FAILURE：失败。 TIMEOUT：超时。	SUCCESS
Model	array	设备型号列表。
	string	设备型号。	SAG-100WM
ErrorCode	string	错误码。	AGENT_LOGIN_FAIL
InspectionMessage	string	巡检信息。	error: Telnet Login failed
TaskId	string	任务 ID。	INSPECTION_TASK9b094655-3c55-443f-bf57-65ede230def4
Role	string	设备角色。	ASW
InspectionResult	string	巡检结果。	{}
IsInspectionResultTruncation	boolean	巡检结果是否截断。	true
DeviceType	string	设备类型。	NETWORK
AlarmStatus	string	告警结果状态。 CRITICAL：严重。 WARNING：警告。	WARNING

示例

正常返回示例

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	服务不可用

访问错误中心查看更多错误码。