智能边缘平台 IEF智能边缘平台 IEF

更新时间:2021/07/08 GMT+08:00
分享

查询终端设备列表

功能介绍

该API用于查询终端设备列表。

URI

GET /v2/{project_id}/edgemgr/devices?{name=xxx,tags=xxx,limit=xxx,offset=xxx}

表1 Path参数

名称

是否必选

说明

project_id

项目ID,获取方法请参见获取项目ID

表2 查询参数

名称

是否必选

参数类型

说明

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进行复合查询。

请求消息

不涉及

响应消息

响应参数:
表3 参数描述

参数

类型

描述

devices

Array of 表5 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
}

错误码

请参见错误码

分享:

    相关文档

    相关产品