V2.5 Cancel Command Tasks¶

取消 Command Tasks。

操作权限¶

使用此 API 前，确保服务账号已被授予包含下列服务和操作权限的策略。有关授权服务账号的更多信息，参见管理服务账号。

需授权的服务	所需操作权限
设备管理服务	Full Access

请求格式¶

POST https://{apigw-address}/connect-service/v2.5/commands?action=cancelTask

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	资产所属的组织ID。如何获取orgId信息>>
jobId	Query	必需	String	Command task所在的Command job ID。

请求参数（Body）¶

名称	必需/可选	数据类型	描述
taskIds	可选	String	Command task 的 ID，范围 1~200。

响应参数¶

名称	数据类型	描述
successSize	Number	成功数。
totalSize	Number	总数。
code	Number	请求返回状态值。0表示请求成功，非0表示请求失败。
msg	String	对状态码的解释和说明。请求成功为 `OK` 。
requestId	String	每次请求获取的ID，用于唯一标识一次API请求。
data	结构体	结构体参见 TaskInfo 结构体

TaskInfo 结构体¶

名称	数据类型	描述
code	Number	请求返回状态值。0表示请求成功，非0表示请求失败。
msg	String	对状态码的解释和说明。请求成功为 `OK` 。
data	String	/

示例¶

请求示例¶

url: https://{apigw-address}/connect-service/v2.5/commands?action=cancelTask&jobId=jobId&orgId=yourOrgId
method: POST
requestBody:
{
    "taskIds": ["taskId"]
}

返回示例¶

{
    "code": 0,
    "msg": "OK",
    "requestId": "requestId",
    "data": [
        {
            "code": 0,
            "msg": "OK",
            "data": "taskId"
        }
    ],
    "successSize": 1,
    "totalSize": 1
}