注意事项
HTTP 状态码
1.5 设备管理
1.5.3 查询设备
接口说明
应用服务器可调用此接口查询物联网平台中指定设备的详细信息。
调试
您可以在API Explorer中调试该接口。
URI
请求方法 GET
URI /v5/iot/{project_id}/devices/{device_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，用于唯一标识 一个设备。在注册设备时直接指 定，或者由物联网平台分配获得。
由物联网平台分配时，生成规则为
"product_id" + "_" + "node_id"拼 接而成。
取值范围：长度不超过128，只允 许字母、数字、下划线（_）、连 接符（-）的组合。
响应参数
名称 类型 说明
app_id String 资源空间ID。
app_name String 资源空间名称。
device_id String 设备ID，用于唯一标识一个设备。在注册设备时 直接指定，或者由物联网平台分配获得。由物联 网平台分配时，生成规则为"product_id" + "_" +
"node_id"拼接而成。
node_id String 设备标识码，通常使用IMEI、MAC地址或Serial No作为node_id。
gateway_id String 网关ID，用于标识设备所属的父设备，即父设备 的设备ID。当设备是直连设备时，gateway_id与 设备的device_id一致。当设备是非直连设备时，
gateway_id为设备所关联的父设备的device_id。
device_nam
e String 设备名称。
node_type String 设备节点类型。
● ENDPOINT：非直连设备。
● GATEWAY：直连设备或网关。
● UNKNOWN：未知。
description String 设备的描述信息。
fw_version String 设备的固件版本。
sw_version String 设备的软件版本。
device_sdk_v
ersion String 设备的sdk信息。
auth_info AuthInfo
Object 设备的接入认证信息。
product_id String 设备关联的产品ID，用于唯一标识一个产品模 型。
product_na
me String 设备关联的产品名称。
status String 设备的状态。
● ONLINE：设备在线。
● OFFLINE：设备离线。
● ABNORMAL：设备异常。
● INACTIVE：设备未激活。
● FROZEN：设备冻结。
名称 类型 说明
create_time String 在物联网平台注册设备的时间。格式：
yyyyMMdd'T'HHmmss'Z'，如 20151212T121212Z。
tags List<TagV5DTO
> 设备的标签列表。
extension_in
fo Object 设备扩展信息。用户可以自定义任何想要的扩展
信息，如果在创建设备时为子设备指定该字段，
将会通过MQTT接口“平台通知网关子设备新增
“将该信息通知给网关。
表1-40 AuthInfo
名称 类型 说明
auth_type String 参数说明：鉴权类型。注意：不填写auth_type默 认为密钥认证接入方式(SECRET)。
取值范围：
● SECRET:使用密钥认证接入方式。
● CERTIFICATES:使用证书认证接入方式。
secret String 参数说明：设备密钥，认证类型使用密钥认证接 入(SECRET)可填写该字段。注意：NB设备密钥由 于协议特殊性，只支持十六进制密钥接入；查询 设备列表接口不返回该参数。
取值范围：长度不低于8不超过32，只允许字 母、数字、下划线（_）、连接符（-）的组合。
fingerprint String 参数说明：证书指纹，认证类型使用证书认证接 入(CERTIFICATES)可填写该字段，注册设备时不 填写该字段则取第一次设备接入时的证书指纹。
取值范围：长度为40的十六进制字符串或者长度 为64的十六进制字符串。
secure_acces
s Boolean 参数说明：指设备是否通过安全协议方式接入。
取值范围：
● true：通过安全协议方式接入。
● false：通过非安全协议方式接入。非安全接入 的设备存在被仿冒等安全风险，请谨慎使用。
名称 类型 说明
timeout Integer 参数说明：设备接入的有效时间，单位：秒，默 认值：0
若设备在有效时间内未接入物联网平台并激活，
则平台会删除该设备的注册信息。若设置为
“0”，则表示平台不会删除该设备的注册信息
（建议填写为“0”）。
注意：只有注册设备接口或者修改设备接口修改 timeout时返回该参数。
表1-41 TagV5DTO
名称 类型 说明
tag_key String 参数说明：标签键，在同一资源下标签键唯一。
绑定资源时，如果设置的键已存在，则将覆盖之 前的标签值。如果设置的键值不存在，则新增标 签。
取值范围：长度不超过64，只允许中文、字母、
数字、以及_.-等字符的组合。
tag_value String 参数说明：标签值。
取值范围：长度不超过128，只允许中文、字 母、数字、以及_.-等字符的组合。
请求示例
GET https://{Endpoint}/v5/iot/{project_id}/devices/{device_id}
Content-Type: application/json X-Auth-Token: ********
Instance-Id: ********
响应示例
Status Code: 200 OK
Content-Type: application/json
{ "app_id" : "jeQDJQZltU8iKgFFoW060F5SGZka", "app_name" : "testAPP01",
"device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "node_id" : "ABC123456789",
"gateway_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f", "device_name" : "dianadevice",
"node_type" : "ENDPOINT", "description" : "watermeter device", "fw_version" : "1.1.0",
"sw_version" : "1.1.0", "auth_info" : {
"auth_type" : "SECRET",
"timeout" : 0
}, "product_id" : "b640f4c203b7910fc3cbd446ed437cbd", "product_name" : "Thermometer",
"status" : "INACTIVE",
"create_time" : "20190303T081011Z", "tags" : [ {
"tag_key" : "testTagName", "tag_value" : "testTagValue"
} ],
"extension_info" : { "aaa" : "xxx",
403 IOTDA .00002 2
Operation not allowed. The user does not have the permission
The application
does not exist. 该应用不存在 请确定是否已在平
Operation not allowed. The application has not been authorized.
该应用没有权限访 问
请检查该应用是否 已被授权。
404 IOTDA .01400 0
The device does
not exist. 设备不存在 请排查请求参数是
您可以在API Explorer中调试该接口。
URI
请求方法 PUT