V2.5 Query Command Job Statistics


查询Command Job 的数据分析信息。

操作权限


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


需授权的服务

所需操作权限

设备管理服务

Read

请求格式

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

请求参数(URI)

名称

位置(Path/Query)

必需/可选

数据类型

描述

orgId

Query

必需

String

资产所属的组织ID。如何获取orgId信息>>

jobId

Query

必需

String

需要查询的 Command Job ID。

响应参数

名称

数据类型

描述

code

number

更新成功或失败的指示码。

msg

String

成功时返回 OK;其他值则为失败。

requestId

String

每次请求获取的 ID,用于唯一标识一次 API 请求。

data

StatusCount 结构体数组

参见 StatusCount 结构体

StatusCount 结构体


名称

数据类型

描述

total

Integer

总和

init

Integer

初始化

published

Integer

已发布

inProgress

Integer

进行中

succeed

Integer

成功

failed

Integer

失败

canceled

Integer

取消

ttlTimeout

Integer

ttl 超时

rspTimeout

Integer

rsp 超时

示例

请求示例

url: https://{apigw-address}/connect-service/v2.5/commands?action=queryJobStatistics&jobId=jobId&orgId=yourOrgId
method: POST

返回示例

{
    "code": 0,
    "msg": "OK",
    "requestId": "7a0a5dee-2b47-4241-95fa-48c6d9a41e23",
    "data": {
        "total": 1,
        "init": 1,
        "published": 0,
        "inProgress": 0,
        "succeed": 0,
        "failed": 0,
        "canceled": 0,
        "ttlTimeout": 0,
        "rspTimeout": 0
    }
}