文档首页 > > API参考> API> 边缘设备管理> 查询边缘设备列表

查询边缘设备列表

分享
更新时间: 2020/06/10 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字段不支持与其它字段实现复合查询。

请求消息

不涉及

响应消息

响应参数:
表3 参数描述

参数

类型

描述

devices

Array of 表4 objects

边缘设备列表

count

Int

满足条件的边缘设备个数

响应示例:

{
    "count": 1,
    "devices": [
        {
            "description": "device_test00",
            "created_at": "2018-08-28T03:45:04",
            "updated_at": null,
            "attributes": {
                "username": {
                    "optional": true,
                    "value": "test",
                    "metadata": {
                        "type": "string"
                    }
                },
                "paasword": {
                    "optional": true,
                    "value": "test",
                    "metadata": {
                        "type": "string"
                    }
                }
            },
            "project_id": "{project_id}",
            "id": "bf81aa80-42e8-4cd2-b352-f97d6832afc3",
            "access_protocol": "userdefine",
            "access_config": {},
            "property_visitors": {},
            "name": "test_device00"
        }
    ]
}

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问