更新时间:2024-10-23 GMT+08:00

查询指定id的命令

功能介绍

物联网平台可查询指定id的命令。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v5/iot/{project_id}/devices/{device_id}/async-commands/{command_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数说明:项目ID。获取方法请参见 获取项目ID

device_id

String

参数说明:下发命令的设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。

取值范围:长度不超过128,只允许字母、数字、下划线(_)、连接符(-)的组合。

command_id

String

参数说明:下发命令的命令id,用于唯一标识一个消息,在下发命令时由物联网平台分配获得。

取值范围:长度不超过100,只允许字母、数字、下划线(_)、连接符(-)的组合。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

Instance-Id

String

参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考 查看实例详情

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

device_id

String

设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。

command_id

String

设备命令ID,用于唯一标识一条命令,在下发设备命令时由物联网平台分配获得。

service_id

String

设备命令所属的设备服务ID,在设备关联的产品模型中定义。

command_name

String

设备命令名称,在设备关联的产品模型中定义。

paras

Object

设备执行的命令,Json格式,里面是一个个键值对,如果service_id不为空,每个键都是profile中命令的参数名(paraName);如果service_id为空则由用户自定义命令格式。设备命令示例:{"value":"1"},具体格式需要应用和设备约定。

expire_time

Integer

物联网平台缓存命令的时长, 单位秒。

status

String

下发命令的状态。

·PENDING表示未下发,在物联网平台缓存着

·EXPIRED表示命令已经过期,即缓存的时间超过设定的expire_time

·SENT表示命令正在下发

·DELIVERED表示命令已送达设备

·SUCCESSFUL表示命令已经成功执行

·FAILED表示命令执行失败

·TIMEOUT表示命令下发之后,没有收到设备确认或者响应结果一定时间后超时

result

Object

设备命令执行的详细结果,由设备返回,Json格式。

created_time

String

命令的创建时间,"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。

sent_time

String

物联网平台发送命令的时间,如果命令是立即下发, 则该时间与命令创建时间一致, 如果是缓存命令, 则是命令实际下发的时间。"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。

delivered_time

String

物联网平台将命令送达到设备的时间,"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。

send_strategy

String

下发策略, immediately表示立即下发,delay表示缓存起来,等数据上报或者设备上线之后下发。

response_time

String

设备响应命令的时间,"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。

请求示例

查询指定id的命令。

GET https://{endpoint}/v5/iot/{project_id}/devices/{device_id}/async-commands/{command_id}

响应示例

状态码: 200

OK

{
  "device_id" : "c1224afb-e9f0-4916-8220-b6bab568e888",
  "command_id" : "b1224afb-e9f0-4916-8220-b6bab568e888",
  "service_id" : "Switch",
  "command_name" : "ON_OFF",
  "paras" : {
    "value" : "ON"
  },
  "expire_time" : 0,
  "send_strategy" : "immediately",
  "created_time" : "20151212T121212Z",
  "status" : "DELIVERED",
  "result" : {
    "code" : 200
  },
  "sent_time" : "20151212T121212Z",
  "delivered_time" : "20151212T121212Z",
  "response_time" : "20151212T131312Z"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码