V2.5 Get Command Tasks¶
获取Command Task。
请求格式¶
GET https://{apigw-address}/connect-service//v2.5/commands?action=getTask
请求参数(URI)¶
名称 | 位置(Path/Query) | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|---|
orgId | Query | 必需 | String | 资产所属的组织ID。如何获取orgId信息>> |
taskId | Query | 必需 | String | 需要获取的 Command Task ID。 |
响应参数¶
名称 | 数据类型 | 描述 |
---|---|---|
code | number | 更新成功或失败的指示码。 |
msg | String | 成功时返回 OK ;其他值则为失败。 |
requestId | String | 每次请求获取的 ID,用于唯一标识一次 API 请求。 |
data | 结构体 | 参见 TaskInfo 结构体。 |
TaskInfo 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
orgId | String | 组织 ID。 |
taskId | String | Command Task ID。 |
productKey | String | ProductKey |
deviceKey | String | DevicetKey |
jobId | String | Command Job ID。 |
status | String | Command Task 状态。可选 INIT,QUEUED,PUBLISHED,IN_PROGRESS,SUCCEED,FAILED,CANCELLED,RSP_TIMEOUT,TTL_TIMEOUT 。 |
commandInfo | 结构体 | 参见 commandInfo 结构体。 |
taskResult | 结构体 | 参见 taskResult 结构体。 |
createTimestamp | Number | 创建时间戳。 |
updateTimestamp | Number | 更新时间戳。 |
autoRetryCount | Integer | 自动重试次数。 |
manualRetryCount | Integer | 手动重试次数。 |
CommandInfo 结构体 ¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
commandType | 可选 | String | 可选择 SERVICE_INVOKE 、MEASUREPOINT_SET |
setMeasurepointInfo | 可选,commandType 为 MEASUREPOINT_SET 时必填。 |
结构体 | 结构体含
|
serviceInvokeInfo | 可选,commandType 为 SERVICE_INVOKE 时必填。 |
结构体 | 结构体含
|
TaskResult 结构体 ¶
名称 | 数据类型 | 描述 |
---|---|---|
code | Integer | 请求返回状态值。0表示请求成功,非0表示请求失败。 |
desc | String | Command Task 描述。 |
outputData | 结构体 | 输出的数据。 |
示例¶
请求示例¶
url: https://{apigw-address}/connect-service/v2.5/commands?action=getTask&orgId=yourOrgId&taskId=taskId
method: GET
返回示例¶
{
"code": 0,
"msg": "OK",
"requestId": "d295525d-1c77-4475-952e-19c1b87b8eb7",
"data": {
"taskId": "taskId",
"orgId": "yourOrgId",
"assetId": "assetId",
"productKey": "productKey",
"deviceKey": "deviceKey",
"jobId": "jobId",
"status": "INIT",
"commandInfo": {
"commandType": "SERVICE_INVOKE",
"serviceInvokeInfo": {
"serviceId": "serviceId",
"inputData": {
"input": 22
}
},
"measurepointSetInfo": null
},
"taskResult": null,
"createTimestamp": 1718952422080,
"updateTimestamp": 1718952422080,
"autoRetryCount": 0,
"manualRetryCount": 0
}
}