更新时间:2024-06-20 GMT+08:00
分享

查数采连接子设备列表

功能介绍

查询数采连接下子设备列表

调试

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

URI

GET /v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources/{ds_id}/devices

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

edge_node_id

String

边缘节点ID

最小长度:1

最大长度:64

ds_id

String

采集数据源id,创建数据源配置时设置,节点下唯一。

最小长度:1

最大长度:64

表2 Query参数

参数

是否必选

参数类型

描述

device_id

String

设备标识码。

最小长度:1

最大长度:128

offset

Integer

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

最小值:0

最大值:1000000

缺省值:0

limit

Integer

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

最小值:0

最大值:1000000

缺省值:10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Long

总记录数

最小值:0

最大值:1000000

page_info

PageInfoDTO object

分页信息

devices

Array of QueryDcDeviceRespDTO objects

每页记录数

数组长度:0 - 1000000

表5 PageInfoDTO

参数

参数类型

描述

offset

Integer

页码

最小值:0

最大值:1000000

limit

Integer

每页记录数

最小值:1

最大值:1000

表6 QueryDcDeviceRespDTO

参数

参数类型

描述

device_id

String

设备id

请求示例

响应示例

状态码: 200

OK

{
  "count" : 1000000,
  "page_info" : {
    "offset" : 1000000,
    "limit" : 1000
  },
  "devices" : [ {
    "device_id" : "MotorVoltage"
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

404

Not Found

错误码

请参见错误码

相关文档