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

查询边缘设备列表

分享
更新时间: 2019/11/11 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

满足条件的边缘设备个数

表4 device

参数

类型

描述

id

String

边缘设备ID

name

String

边缘设备名称

description

String

边缘设备描述

attributes

Object

边缘设备静态属性,最多64个键值。

key为属性名称,value格式请参见表7,示例如下。

"attributes": {
            "username": {
                "value": "test",
                "optional": true,
                "metadata": {
                    "type": "string"
                }
            }
        }

created_at

String

创建时间

updated_at

String

更新时间

project_id

String

项目ID

relation

String

设备和节点关联的名称(当通过node_id检索是有值)

comment

String

设备和节点关联的备注(当通过node_id检索是有值)

access_protocol

String

访问协议,有如下选项:

  • userdefine:自定义协议
  • modbus:modbus协议
  • opc-ua:opc-ua协议

access_config

表25 object

访问配置,与access_protocol直接关联。

property_visitors

表26 object

孪生属性配置,与access_protocol关联。

state

String

边缘设备的状态

last_online

String

边缘设备最后活跃的时间

twin

Object

边缘设备动态属性,最多64个键值。

key为属性名称,value格式请参见表8,示例如下。

"twin": {
            "devicestate": {
                "optional": true,
                "expected": {
                    "value": "running"
                },
                "metadata": {
                    "type": "string"
                }
            }
        }

connection_type

String

连接类型,非直连设备为edge,直连设备为mqtt

响应示例:

{
    "count": 1,
    "devices": [
        {
            "description": "device_test00",
            "created_at": "2018-08-28T03:45:04",
            "last_online": null,
            "updated_at": null,
            "state": "offline",
            "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

提交反馈 取消

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

跳转到云社区