更新时间:2022-05-05 GMT+08:00
分享

查询设备列表

功能介绍

查询设备列表

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/edge-nodes/{edge_node_id}/devices

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:1

最大长度:64

edge_node_id

String

边缘节点ID

最小长度:1

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

gateway_id

String

父设备ID,对应之前的gatewayId的概念,传该参数时代表查询网关下的子设备,不传代表节点下的

最小长度:0

最大长度:256

device_name

String

设备名称

最小长度:0

最大长度:256

offset

Integer

查询的起始位置,取值范围为非负整数,默认为0

最小值:0

最大值:1000000

缺省值:0

limit

Integer

每页记录数,默认值为10,取值区间为1-1000

最小值:1

最大值:1000

缺省值:10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

最小长度:0

最大长度:20000

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

devices

Array of QueryDeviceSimplifyDto objects

查询设备列表响应结构体

count

Long

满足查询条件的记录总数。

最小值:0

最大值:1000000

page_info

PageInfoDTO object

分页信息

表5 QueryDeviceSimplifyDto

参数

参数类型

描述

device_id

String

设备id

最小长度:0

最大长度:256

node_id

String

设备识别码

最小长度:0

最大长度:64

gateway_id

String

父设备id

最小长度:0

最大长度:256

device_name

String

设备名称

最小长度:0

最大长度:256

protocol_type

String

设备协议类型

最小长度:0

最大长度:20

product_name

String

产品名称

最小长度:0

最大长度:255

product_id

String

产品ID

最小长度:0

最大长度:255

表6 PageInfoDTO

参数

参数类型

描述

offset

Integer

页码

最小值:0

最大值:1000000

limit

Integer

每页记录数

最小值:1

最大值:1000

请求示例

GET https://{endpoint}/v2/{project_id}/edge-nodes/{edge_node_id}/devices

响应示例

状态码

状态码

描述

200

OK

401

Bad Request

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品

close