查询数据源配置列表
功能介绍
查询数据源配置列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/edge-nodes/{edge_node_id}/ots/data-sources
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见 获取项目ID。 |
|
edge_node_id |
是 |
String |
边缘节点ID 最小长度：1 最大长度：64 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
module_id |
否 |
String |
数据源所属的模块id 最小长度：1 最大长度：64 |
|
offset |
否 |
Integer |
查询的起始位置，取值范围为非负整数，默认为0 最小值：0 最大值：1000000 缺省值：0 |
|
limit |
否 |
Integer |
每页记录数，默认值为10，取值区间为1-1000 最小值：0 最大值：1000000 缺省值：10 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Long |
总记录数 最小值：0 最大值：1000000 |
|
page_info |
PageInfoDTO object |
分页信息 |
|
datasources |
Array of QueryDcDsBriefRespDTO objects |
每页记录数 数组长度：0 - 1000000 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
ds_id |
String |
采集数据源id，节点下唯一 最小长度：1 最大长度：64 |
|
name |
String |
采集数据源名称，允许中、数字、英文大小写、下划线、中划线 最小长度：1 最大长度：64 |
|
edge_node_id |
String |
边缘节点id 最小长度：1 最大长度：64 |
|
module_id |
String |
模块id 最小长度：1 最大长度：64 |
|
tpl_id |
String |
模板id，节点下唯一 最小长度：1 最大长度：64 |
|
quality_report |
Boolean |
质量上报开关，不携带或值不为true，默认为false 缺省值：false |
|
edge_app_name |
String |
应用ID 最小长度：0 最大长度：64 |
|
connection_info |
Object |
数采连接信息 |
|
module_state |
String |
数采连接状态,RUNNING|STOPPED 最小长度：1 最大长度：32 |
|
count |
Long |
数采连接下点位数 最小值：0 最大值：1000000 |
|
create_time |
String |
创建时间 最小长度：0 最大长度：256 |
|
update_time |
String |
最后一次修改时间 最小长度：0 最大长度：256 |
|
synchronized |
Boolean |
数采配置是否已同步，已同步：true,未同步：false |
|
synchronized_time |
String |
数采配置同步时间 最小长度：0 最大长度：256 |
请求示例
无
响应示例
状态码： 200
OK
{
"count" : 1000000,
"page_info" : {
"offset" : 1000000,
"limit" : 1000
},
"datasources" : [ {
"ds_id" : "opcua_1",
"name" : "电力子系统",
"edge_node_id" : "446007715895193600",
"module_id" : "user_opc_ua_yz",
"tpl_id" : "sys_general_opcua",
"quality_report" : false,
"edge_app_name" : "西门子OPCUA驱动",
"connection_info" : { },
"module_state" : "STOPPED",
"count" : "1000000,",
"create_time" : "2020-05-28T11:31:29.740Z",
"update_time" : "2020-05-28T11:31:29.740Z",
"synchronized" : true,
"synchronized_time" : "2020-05-28T11:31:29.740Z"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
404 |
Not Found |
错误码
请参见错误码。
