查询源数据源列表
功能介绍
查询源数据源列表
URI
GET /v2/{project_id}/link/instances/{instance_id}/rules/{rule_id}/sources
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。 最小长度:0 最大长度:32 |
instance_id |
是 |
String |
实例ID 最小长度:0 最大长度:36 |
rule_id |
是 |
String |
规则ID 最小长度:0 最大长度:20 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页显示条目数量,最大数量999,超过999后只返回999 最小值:0 最大值:999999 缺省值:10 |
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询, offset大于等于0 最小值:0 最大值:999999 缺省值:0 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total |
Integer |
总数 最小值:0 最大值:9999999999999999 |
size |
Integer |
本次返回数量 最小值:0 最大值:999 |
items |
Array of Source objects |
数据源列表 |
参数 |
参数类型 |
描述 |
---|---|---|
source_id |
Integer |
源数据源ID 最小值:1 最大值:99999999999999999 |
product_id |
Integer |
产品ID 最小值:1 最大值:99999999999999999 |
device_id |
Integer |
设备ID,不填为全部设备 最小值:1 最大值:99999999999999999 |
topic |
String |
主题,当设备ID为空时为产品级主题,设备ID不为空时为设备级主题 最小长度:0 最大长度:200 |
device_name |
String |
设备名称 最小长度:0 最大长度:64 |
product_name |
String |
产品名称 最小长度:0 最大长度:64 |
is_base64 |
Integer |
是否payload使用base64,0-是 1-否 最小值:0 最大值:10 缺省值:1 |
contain_device_info |
Integer |
是否包含设备信息,0-是 1-否 最小值:0 最大值:10 缺省值:1 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
系统错误码,针对4xx和5xx类HTTP错误码的详细错误码 最小长度:0 最大长度:64 |
error_msg |
String |
错误描述 最小长度:0 最大长度:200 |
request_id |
String |
消息ID 最小长度:0 最大长度:64 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
系统错误码,针对4xx和5xx类HTTP错误码的详细错误码 最小长度:0 最大长度:64 |
error_msg |
String |
错误描述 最小长度:0 最大长度:200 |
request_id |
String |
消息ID 最小长度:0 最大长度:64 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
系统错误码,针对4xx和5xx类HTTP错误码的详细错误码 最小长度:0 最大长度:64 |
error_msg |
String |
错误描述 最小长度:0 最大长度:200 |
request_id |
String |
消息ID 最小长度:0 最大长度:64 |
请求示例
GET /{project_id}/link/instances/{instance_id}/rules/{rule_id}/sources
响应示例
状态码: 200
OK
{ "total" : 1, "size" : 1, "items" : [ { "source_id" : 35296, "product_id" : 122893, "device_id" : 711568, "topic" : "/v1/devices/214/datas", "device_name" : "device", "product_name" : "product", "is_base64" : 0, "contain_device_info" : 0 } ] }
状态码: 400
Bad Request
{ "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-rulesrc.query]. Parameter is [rule_oid]. Processor is [path].", "requestId" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" }
状态码: 404
Not Found
{ "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "requestId" : "13984193-ca65-4954-9b7f-4b7d680399d6-1619678681445-cnnorth7a-P-romalink-service01" }
状态码: 500
Internal Server Error
{ "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。