V2.5 Search Command Tasks¶

搜索Command Task的详情及执行进度、状态。

操作权限¶

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

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

请求格式¶

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

请求参数（URI）¶

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

请求参数（Body）¶

名称

必需/可选

数据类型

描述

expression

可选

String

查询表达式，支持类 SQL 的查询。

jobId 支持 eq in。
ztaskId 支持 eq in。
assetId pk dk 支持``eq in``。
status 支持``eq in``。
createTime 支持 eq lt lte gt gte

如何使用查询表达式>>

pagination

可选

Pagination 请求结构体

参见 Pagination 请求结构体>>

pageNo： Number，分页从 1 开始，最小值默认值为 1。支持 eq in。
pageSize：Number，范围 0~1000。

响应参数¶

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

TaskInfo 结构体¶

名称	数据类型	描述
taskId	String	所执行的Command Task 的 ID。
orgId	String	资产所属的组织 ID。
assetId	String	设备的 asset ID。
productKey	String	设备的 product key。如何获取设备的 productKey 信息>>
deviceKey	String	设备的 Device Key。如何获取设备的 deviceKey 信息>>
jobId	String	Command Job 的 ID。
status	String	Command Job 状态。
commandInfo	结构体	参见 commandInfo 结构体。
taskResult	结构体	参见 taskResult 结构体。
createTimestamp	Number	创建时间戳。
updateTimestamp	Number	更新时间戳。
autoRetryCount	Integer	自动重试次数。
manualRetryCount	Integer	手动重试次数。

CommandInfo 结构体 ¶

名称

必需/可选

数据类型

描述

commandType

可选

String

可选择 SERVICE_INVOKE、MEASUREPOINT_SET

setMeasurepointInfo

可选

结构体

结构体含

measurepointId：String，资产测点。如何获取测点（pointId）信息>>
value：String，Json，Integer，设置测点的值。

serviceInvokeInfo

可选

结构体

结构体含

serviceId：String，被调用服务ID。
inputData：String，服务调用的输入参数，key为参数标识符，value值类型需要符合 ThingModel 的定义。

TaskResult 结构体 ¶

名称	数据类型	描述
code	String	请求返回状态值。0表示请求成功，非0表示请求失败。
desc	String	对状态码的解释和说明。请求成功为 OK 。
outputData	结构体	输出的数据。

示例¶

请求示例¶

url: https://{apigw-address}/connect-service/v2.5/commands?action=searchTask&orgId=yourOrgId
method: POST
requestBody:
{
    "expression": "jobId in ('jobId')",
    "pagination": {
        "pageNo": 1,
        "pageSize": 100
    }
}

返回示例¶

{
    "code": 0,
    "msg": "OK",
    "requestId": "2280717f-ad1f-4329-9168-b8504aa537c7",
    "data": [
        {
            "taskId": "taskId",
            "orgId": "yourOrgId",
            "assetId": "assetId",
            "productKey": "productKey",
            "deviceKey": "deviceKey",
            "jobId": "jobId",
            "status": "status",
            "commandInfo": {
                "commandType": "commandType",
                "serviceInvokeInfo": {
                    "serviceId": "serviceId",
                    "inputData": {
                        "input": 22
                    }
                },
                "measurepointSetInfo": null
            },
            "taskResult": null,
            "createTimestamp": 1718952422080,
            "updateTimestamp": 1718952422080,
            "autoRetryCount": 0,
            "manualRetryCount": 0
        }
    ],
    "pagination": {
        "sortedBy": null,
        "pageNo": 1,
        "pageSize": 100,
        "totalSize": 1
    }
}