注意事项
HTTP 状态码
1.7 设备命令
1.7.2 设备异步命令
1.7.2.2 查询指定 id 的命令 接口说明
Command counts reached upper limit.
命令数量达到上限 请等待缓存命令下 发后再下发新命令, 或增大缓存命令 数。
404 IOTDA .01400 0
The device does
not exist. 设备不存在 请排查请求参数是 否有误并确认是否 有在平台注册该设 备。
500 IOTDA .00000 1
Internal server
error. 服务器内部错误 请联系华为工程师
分析解决。
IOTDA .00002 0
Decrypt IAM token
failed. IAM Token解析失
败 请联系华为工程师
分析解决。
1.7.2.2 查询指定 id 的命令 接口说明
物联网平台可查询指定id的命令。
调试
您可以在API Explorer中调试该接口。
URI
请求方法 GET
URI /v5/iot/{project_id}/devices/{device_id}/async-commands/
{command_id}
传输协议 HTTPS
请求参数
名称 必选/可
选
类型 位置 说明
X-Auth-Token 必选 String Head
er 参数说明:用户Token。通过调用 IAM服务 获取IAM用户Token接口 获取,接口返回的响应消息头中
“X-Subject-Token”就是需要获 取的用户Token。简要的获取方法 样例请参见 Token认证。
Instance-Id 可选 String Head
er 参数说明:实例ID。物理多租下各 实例的唯一标识,一般华为云租户 无需携带该参数,仅在物理多租场 景下从管理面访问API时需要携带 该参数。
project_i
d 必选 String Path 参数说明:项目ID。获取方法请参 见 获取项目ID。
device_id 必选 String Path 参数说明:下发命令的设备ID,用 于唯一标识一个设备,在注册设备 时由物联网平台分配获得。
取值范围:长度不超过128,只允 许字母、数字、下划线(_)、连 接符(-)的组合。
comman
d_id 必选 String Path 参数说明:下发命令的命令id,用 于唯一标识一个消息,在下发命令 时由物联网平台分配获得。
取值范围:长度不超过100,只允 许字母、数字、下划线(_)、连 接符(-)的组合。
响应参数
名称 类型 说明
device_id String 设备ID,用于唯一标识一个设备,在注册设备时 由物联网平台分配获得。
command_i
d String 设备命令ID,用于唯一标识一条命令,在下发设
备命令时由物联网平台分配获得。
service_id String 设备命令所属的设备服务ID,在设备关联的产品 模型中定义。
command_n
ame 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_tim
e String 命令的创建时间,"yyyyMMdd'T'HHmmss'Z'"格 式的UTC字符串。
sent_time String 物联网平台发送命令的时间,如果命令是立即下 发, 则该时间与命令创建时间一致, 如果是缓存 命令, 则是命令实际下发的时间。
"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串。
delivered_ti
me String 物联网平台将命令送达到设备的时间,
"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串 send_strateg
y String 下发策略, immediately表示立即下发,delay表 示缓存起来,等数据上报或者设备上线之后下 发。
response_ti
me String 设备响应命令的时间,
"yyyyMMdd'T'HHmmss'Z'"格式的UTC字符串
请求示例
GET https://{Endpoint}/v5/iot/{project_id}/devices/{device_id}/async-commands/{command_id}
Content-Type: application/json X-Auth-Token: ********
Instance-Id: ********
响应示例
Content-Type: application/json
{ "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"
}
错误码
HTTP 状态码
错误码 错误码英文描述 错误码中文描述 处理建议
403 IOTDA .00002 1
Operation not allowed. User not found by IAM token or the authorized user has not subscribed IOTDA service.
没有找到IAM Token所对应的用户 信息或该用户没有 订阅设备接入服务
(IOTDA)
请排查IAM Token 所在用户是否订阅
Operation not allowed. The user does not have the permission
Operation not allowed.
Application not found by
authorized user or the authorized user has no application.
Operation not allowed. The device has been frozen, can not be operated.
设备已被冻结,不 允许操作
请将设备解冻后再 重试。
404 IOTDA .01400 0
The device does
not exist. 设备不存在 请排查请求参数是 否有误并确认是否 有在平台注册该设 备。
HTTP 状态码
错误码 错误码英文描述 错误码中文描述 处理建议
500 IOTDA .00000