查询设备
功能介绍
应用服务器可调用此接口查询物联网平台中指定设备的详细信息。
URI
GET /v5/iotps/{project_id}/devices/{device_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 最小长度：1 最大长度：32 |
|
device_id |
是 |
String |
设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。（生成规则为"product_id" + "_" + "node_id"拼接而成） 最小长度：1 最大长度：128 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
device_id |
String |
设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。（生成规则为"product_id" + "_" + "node_id"拼接而成） 最小长度：0 最大长度：256 |
|
node_id |
String |
设备标识码，通常使用IMEI、MAC地址或Serial No作为nodeId。 最小长度：0 最大长度：64 |
|
gateway_id |
String |
网关ID，用于标识一个网关设备。当设备是直连设备时，gatewayId与设备的deviceId一致。当设备是非直连设备时，gatewayId为设备所关联的直连设备（即网关）的deviceId。 最小长度：0 最大长度：256 |
|
device_name |
String |
设备名称。 最小长度：0 最大长度：256 |
|
node_type |
String |
设备节点类型。
|
|
description |
String |
设备的描述信息。 最小长度：0 最大长度：2048 |
|
auth_info |
AuthInfo object |
设备的接入认证信息。 |
|
product_id |
String |
设备关联的产品ID，用于唯一标识一个产品模型。 |
|
product_name |
String |
设备关联的产品名称。 最小长度：1 最大长度：255 |
|
protocol_type |
String |
设备关联的产品协议类型。 |
|
create_time |
String |
在物联网平台注册设备的时间。 最小长度：0 最大长度：128 |
|
provision_info |
ProvisionInfoBaseResp object |
设备的发放信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
auth_type |
String |
鉴权类型。支持秘钥认证接入(SECRET)和证书认证接入(CERTIFICATES)。使用秘钥认证接入方式(SECRET)填写secret字段，使用证书认证接入方式(CERTIFICATE)填写fingerprint字段，如果CA证书选择云证书管理服务的CA证书，不需要填写fingerprint字段，需要填写设备证书名称字段，不填写auth_type默认为秘钥认证接入方式(SECRET) |
|
secret |
String |
设备秘钥，认证类型使用秘钥认证接入(SECRET)可填写该字段。注意：NB设备秘钥由于协议特殊性，只支持十六进制秘钥接入。 最小长度：8 最大长度：32 |
|
fingerprint |
String |
证书指纹，认证类型使用证书认证接入(CERTIFICATES)可填写该字段，注册设备时不填写该字段则取第一次设备接入时的证书指纹。注意：指纹只能为40位十六进制字符串或者64位十六进制字符串。 |
|
device_cert_name |
String |
设备证书名称，CA证书选择云证书管理服务的CA证书接入需要填写该字段。此名称会也即设备证书使用者的CommanName |
|
device_cert_validity |
Integer |
生成设备证书的有效期。CA证书选择云证书管理服务的CA证书可填写该字段。 最小值：1 最大值：10 |
|
device_cert_id |
String |
设备证书id，设备采用云证书管理服务的CA注册，云证书管理服务生成的设备证书的唯一实例ID |
|
secure_access |
Boolean |
指设备是否通过安全协议方式接入，默认值为true。
缺省值：true |
|
timeout |
Integer |
设备验证码的有效时间，单位：秒，默认值：0 若设备在有效时间内未接入物联网平台并激活，则平台会删除该设备的注册信息。若设置为“0”，则表示设备验证码不会失效（建议填写为“0”）。 缺省值：0 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
access_point |
AccessPointResp object |
发放区域。 |
|
app_info |
ApplicationResp object |
所属应用。 |
|
cert_name |
String |
CA证书名称。设备认证类型为证书认证时返回。 最小长度：0 最大长度：256 |
|
allocation_status |
Integer |
设备发放状态。 取值如下：
最小值：0 最大值：3 |
|
allocation_strategy_type |
String |
策略类型。 取值如下：
缺省值：base |
|
life_time |
Integer |
LWM2M设备导入的默认生命周期。 最小值：0 最大值：864000 |
|
init_config |
String |
设备的初始化配置。 最小长度：1 最大长度：65535 |
请求示例
查询设备
GET https://{endpoint}/v5/iotps/{project_id}/devices/d4922d8a-6c8e-4396-852c-164aefa6638f
响应示例
状态码： 200
OK
{
"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",
"auth_info" : {
"auth_type" : "SECRET",
"secret" : "3b935a250c50dc2c6d481d048cefdc3c",
"fingerprint" : "dc0f1016f495157344ac5f1296335cff725ef22f",
"secure_access" : true,
"timeout" : 300
},
"product_id" : "b640f4c203b7910fc3cbd446ed437cbd",
"create_time" : "20190303T081011Z",
"product_name" : "waterMater",
"protocol_type" : "LWM2M",
"provision_info" : {
"access_point" : {
"access_point_id" : "cn-north-4",
"access_point_name" : "cn-north-4",
"region_id" : "cn-north-4"
},
"app_info" : {
"app_id" : "b640f4c203b7910fc3cbd446ed437cbd",
"app_name" : "mqttAppName"
},
"allocation_status" : 0,
"allocation_strategy_type" : "base",
"life_time" : 86400
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
403 |
Forbidden |
|
500 |
Internal Server Error |
错误码
请参见错误码。
