更新时间:2024-07-03 GMT+08:00

查询目标数据源列表

功能介绍

查询目标数据源列表。

URI

GET /v2/{project_id}/link/instances/{instance_id}/rules/{rule_id}/destinations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。

最小长度:0

最大长度:32

instance_id

String

实例ID。

最小长度:0

最大长度:36

rule_id

String

规则ID。

最小长度:0

最大长度:20

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页显示条目数量,最大数量999,超过999后只返回999。

最小值:1

最大值:999999

缺省值:10

offset

Integer

偏移量,表示从此偏移量开始查询, offset大于等于0。

最小值:0

最大值:999999

缺省值:0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:100000

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

总数

最小值:0

最大值:9999999999999999

size

Integer

本次返回数量。

最小值:0

最大值:999

items

Array of Destination objects

目标数据源列表。

数组长度:0 - 9999

表5 Destination

参数

参数类型

描述

destination_id

Integer

目标数据源ID。

最小值:1

最大值:99999999999999999

destination_type

Integer

操作类型,枚举值:0-目标端为本ROMA实例内MQS;7-目标端为设备。

最小值:0

最大值:10

app_id

String

应用ID,目标端为0时需明确对方的APP_ID。

最小长度:0

最大长度:64

destination_name

String

目标数据源名称。

最小长度:0

最大长度:255

topic

String

目标数据源主题。

最小长度:0

最大长度:64

server

String

目标端数据源服务。

最小长度:0

最大长度:200

token

String

目标端数据源Token。

最小长度:0

最大长度:1000

tag

String

目标数据源标签。

最小长度:0

最大长度:200

mqs_sasl_ssl

Boolean

目标端数据源MQS的SASL字段是否需要支持SSL加密。

user_name

String

目标数据源用户名。

最小长度:0

最大长度:80

password

String

目标数据源密码。

最小长度:0

最大长度:500

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码。

最小长度:0

最大长度:64

error_msg

String

错误描述。

最小长度:0

最大长度:200

request_id

String

消息ID。

最小长度:0

最大长度:64

状态码: 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

系统错误码,针对4xx和5xx类HTTP错误码的详细错误码。

最小长度:0

最大长度:64

error_msg

String

错误描述。

最小长度:0

最大长度:200

request_id

String

消息ID。

最小长度:0

最大长度:64

状态码: 500

表8 响应Body参数

参数

参数类型

描述

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}/destinations

响应示例

状态码: 200

OK

{
  "total" : 1,
  "size" : 1,
  "items" : [ {
    "destination_id" : 27678,
    "destination_type" : 7,
    "app_id" : null,
    "destination_name" : null,
    "topic" : "8si8ST122893/in/214",
    "server" : "server",
    "token" : "token",
    "tag" : "device",
    "mqs_sasl_ssl" : "false",
    "user_name" : null,
    "password" : null
  } ]
}

状态码: 400

Bad Request

{
  "error_code" : "SCB.00000000",
  "error_msg" : "Parameter is not valid for operation [romalink.link-ruledest.query]. Parameter is [rule_oid]. Processor is [path].",
  "request_id" : "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.",
  "request_id" : "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

错误码

请参见错误码