更新时间：2024-04-22 GMT+08:00
查询终端设备列表
功能介绍
该API用于查询终端设备列表。
URI
GET /v2/{project_id}/edgemgr/devices?{name=xxx,tags=xxx,limit=xxx,offset=xxx}
|
名称 |
是否必选 |
说明 |
|---|---|---|
|
project_id |
是 |
项目ID，获取方法请参见获取项目ID。 |
|
名称 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
name |
否 |
String |
终端设备名称，模糊匹配 |
|
node_id |
否 |
String |
节点ID，精确匹配 |
|
limit |
否 |
String |
每页显示的条目数量，取值范围1~1000，默认为1000 |
|
offset |
否 |
String |
查询的起始位置，取值范围为非负整数，默认为0 |
|
is_binding |
否 |
String |
是否绑定到边缘节点，为“true”时返回所有已绑定到节点的设备列表，为“false”则返回未绑定节点的设备列表 |
|
tags |
否 |
String |
标签的key和value通过点连接，多个标签通过逗号连接，如：tags=key1.value1,key2.value2 |
- 如果不携带任何检索参数，将返回该租户的所有终端设备信息。
- tags和node_id支持复合查询，可以同时携带多个其他检索参数，同时生效。
- is_binding字段不支持与tags和node_id进行复合查询。
请求消息
|
参数 |
是否必选 |
类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
消息体的类型（格式） 推荐您使用默认值application/json。 |
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
ief-instance-id |
否 |
String |
铂金版实例ID，专业版实例为空值 |
响应消息
响应参数
|
参数 |
类型 |
描述 |
|---|---|---|
|
devices |
Array of 表6 objects |
终端设备列表 |
|
count |
Integer |
满足条件的终端设备个数 |
响应示例
{
"devices": [
{
"id": "1398f13d-f24d-4de4-8cd3-5905db1d6d9f",
"name": "device",
"access_protocol": "",
"project_id": "05e1aef9040010e22fccc009adecb056",
"description": "",
"created_at": "2020-09-23T02:00:22.858736Z",
"updated_at": "",
"access_config": {},
"connection_type": "edge"
}
],
"count": 1
}
错误码
请参见错误码。
父主题： 终端设备管理
