文档首页/ IoT边缘 IoTEdge/ API参考/ API列表/ 设备管理/ 查询设备列表
更新时间：2025-04-09 GMT+08:00
查看PDF
分享

查询设备列表

功能介绍

查询设备列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

edge_node_id

是

String

边缘节点ID
表2 Query参数

参数

是否必选

参数类型

描述

gateway_id

否

String

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

device_name

否

String

设备名称

module_id

否

String

设备所属的模块id

device_id

否

String

设备ID

offset

否

Integer

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

limit

否

Integer

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

devices

Array of QueryDeviceSimplifyDto objects

查询设备列表响应结构体

count

Long

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

page_info

PageInfoDTO object

分页信息
表5 QueryDeviceSimplifyDto

参数

参数类型

描述

device_id

String

设备id

node_id

String

设备识别码

gateway_id

String

父设备id

device_name

String

设备名称

protocol_type

String

设备协议类型

product_name

String

产品名称

product_id

String

产品ID
表6 PageInfoDTO

参数

参数类型

描述

offset

Integer

页码

limit

Integer

每页记录数

请求示例

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

响应示例

状态码：200

OK

{
  "devices" : [ {
    "device_id" : "string",
    "node_id" : "string",
    "gateway_id" : "string",
    "device_name" : "string",
    "protocol_type" : "string",
    "product_name" : "string",
    "product_id" : "string"
  } ],
  "count" : "0,",
  "page_info" : {
    "offset" : 1000000,
    "limit" : 1000
  }
}

状态码

状态码

描述

200

OK

401

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 设备管理

相关文档