调用GetInspectionTask获取巡检任务详情_云网管(CMN)-阿里云帮助中心

获取巡检任务详情。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
TaskId	string	否	巡检任务 ID。	INSPECTION_TASK3f28ca10-8599-4c1b-9b98-072444546e49
DeviceId	string	否	设备 ID。	device-ak0rnxtulk******
ItemName	string	否	巡检项名字。	config_backup
InstanceId	string	是	实例 ID。	cmn-cn-xxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	AC8F05E6-AFBB-4ABE-B75E-A6539A9BAAA8
InspectionTask	object	巡检任务对象。
TaskId	string	巡检任务 ID。	INSPECTION_TASK3f28ca10-8599-4c1b-9b98-072444546e49
Space	string	物理空间。	XX门店
DeviceId	string	设备 ID。	device-ak0rnxtulk******
InspectionResult	string	巡检结果。	{}
InspectionAlarmRules	array<object>	告警规则列表。
	object	告警规则对象。
Expression	string	告警条件表达式。	cpu_usage
Operator	string	运算符。	>
Value	string	告警阈值。	10
ActualValue	string	巡检结果值。	11
Level	string	告警级别。	WARNING
IP	string	IP 地址。	127.0.0.1
HostName	string	主机名。	ASW-S-3F1-1.CD1
Vendor	string	厂商。	Alibaba
TaskStatus	string	任务状态。	SUCCESS
ItemId	string	巡检项 ID。	INSPECTION_ITEM-sjds-23
ExecutionEndTime	string	巡检结束时间。	2020-12-23 03:18:22
ExecutionBeginTime	string	巡检开始时间。	2020-12-23 03:18:22
Model	array	巡检项适用的设备型号列表。
	string	设备型号。	SAG-100WM
ItemName	string	巡检项名字。	config_backup
ErrorCode	string	巡检结果错误码。	AGENT_LOGIN_FAIL
ScriptId	string	模板 ID。	INSPECTION_TEMPLATE-sdsld
DeviceDisplay	string	设备回显。	device output sample

示例

正常返回示例

JSON格式

{
  "RequestId": "AC8F05E6-AFBB-4ABE-B75E-A6539A9BAAA8",
  "InspectionTask": {
    "TaskId": "INSPECTION_TASK3f28ca10-8599-4c1b-9b98-072444546e49",
    "Space": "XX门店",
    "DeviceId": "device-ak0rnxtulk******",
    "InspectionResult": "{}",
    "InspectionAlarmRules": [
      {
        "Expression": "cpu_usage",
        "Operator": ">",
        "Value": "10",
        "ActualValue": "11",
        "Level": "WARNING"
      }
    ],
    "IP": "127.0.0.1",
    "HostName": "ASW-S-3F1-1.CD1",
    "Vendor": "Alibaba",
    "TaskStatus": "SUCCESS",
    "ItemId": "INSPECTION_ITEM-sjds-23",
    "ExecutionEndTime": "2020-12-23 03:18:22",
    "ExecutionBeginTime": "2020-12-23 03:18:22",
    "Model": [
      "SAG-100WM"
    ],
    "ItemName": "config_backup",
    "ErrorCode": "AGENT_LOGIN_FAIL",
    "ScriptId": "INSPECTION_TEMPLATE-sdsld",
    "DeviceDisplay": "device output sample"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Missing%s	You must specify the parameter %s.	必填参数没有填。请检查调用时是否填写了此参数，并重试请求。
400	SignatureDoesNotMatch	签名不通过	-
403	NoPermission	没有权限	-
404	Invalid%s.NotFound	The specified resource %s does not exist.	找不到对应资源
404	ServiceNotFound	后端服务未找到	-
500	InternalError	服务器内部错误	-
503	ServiceUnavailable	服务不可用	-

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