查询注册组下的设备
功能介绍
应用服务器可调用此接口查询物联网平台中注册组设备信息。
URI
GET /v5/iotps/{project_id}/registration-groups/{registration_group_id}/devices
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目id。 最小长度：1 最大长度：32 |
|
registration_group_id |
是 |
String |
注册组id，用于唯一标识一个注册组 最小长度：1 最大长度：256 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
分页查询时每页显示的记录数，默认值为10，取值范围为1-50的整数。 最小值：1 最大值：50 缺省值：10 |
|
marker |
否 |
String |
上一次分页查询结果中最后一条记录的ID，在上一次分页查询时由物联网平台返回获得。分页查询时物联网平台是按marker也就是记录ID降序查询的，越新的数据记录ID也会越大。若填写marker，则本次只查询记录ID小于marker的数据记录。若不填写，则从记录ID最大也就是最新的一条数据开始查询。如果需要依次查询所有数据，则每次查询时必须填写上一次查询响应中的marker值。 缺省值：999999999999999999999999 最小长度：24 最大长度：24 |
|
device_id |
否 |
String |
设备ID，支持模糊查询。 最小长度：4 最大长度：128 |
|
device_name |
否 |
String |
设备名称。 最小长度：0 最大长度：256 |
|
status |
否 |
String |
设备引导状态。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
registration_group_devices |
Array of RegistrationGroupDevices objects |
注册组信息。 数组长度：0 - 1000 |
|
page |
Page object |
查询结果的分页信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
device_id |
String |
设备id，用于唯一标识一个设备 最小长度：1 最大长度：256 |
|
app_name |
String |
应用名。 最小长度：1 最大长度：256 |
|
access_point_name |
String |
接入点名称。 最小长度：1 最大长度：256 |
|
device_name |
String |
设备名称。 最小长度：1 最大长度：256 |
|
status |
Integer |
设备引导状态。 取值如下：
最小值：0 最大值：2 |
|
create_time |
String |
在物联网平台注册设备的时间。 最小长度：0 最大长度：128 |
|
modify_time |
String |
在物联网平台修改设备的时间。 最小长度：0 最大长度：128 |
请求示例
无
响应示例
状态码： 200
OK
{
"registration_group_devices" : [ {
"device_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
"app_name" : "ABC123456789",
"access_point_name" : "d4922d8a-6c8e-4396-852c-164aefa668f",
"device_name" : "dianadevice"
} ],
"page" : {
"count" : 1,
"marker" : "d4922d8a-6c8e-4396-852c-164aefa6638f"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
404 |
Not Found |
错误码
请参见错误码。
