文档首页/应用与数据集成平台 ROMA Connect/API参考（阿布扎比区域）/服务集成API/自定义后端服务/查询自定义后端服务数据源列表
更新时间：2025-03-28 GMT+08:00
查看PDF
分享

查询自定义后端服务数据源列表

功能介绍

查询自定义后端服务数据源列表。

URI

GET /v2/{project_id}/apic/instances/{instance_id}/data-sources

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Long

偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0

缺省值：0

limit

否

Integer

每页显示的条目数量

最小值：1

最大值：500

缺省值：20

app_id

是

String

应用编号

name

否

String

数据源名称

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

data_sources

Array of LdDatasourceInfo objects

数据源列表

表5 LdDatasourceInfo

参数

参数类型

描述

name

String

数据源名称

type

String

数据源类型：

  • oracle：oracle数据源类型
  • mysql：mysql数据源类型
  • mongodb：mongodb数据源类型
  • redis：redis数据源类型
  • postgresql：postgresql数据源类型
  • hive：hive数据源类型
  • mssql：sqlserver数据源类型
  • sqlserver：sqlserver数据源类型
  • gauss200：gauss200数据源类型
  • dws：dws数据源类型
  • gauss100：gauss100数据源类型
  • zenith：zenith数据源类型

description

String

数据源描述

url

String

数据源连接字符串

user

String

用户名

password

String

密码。

敏感信息不作为响应返回

remotepath

String

ftp上传路径

预留字段，暂不支持。

id

String

数据源ID

status

String

数据源状态：

  • old：存量数据源
  • new：roma数据源

created_time

String

数据源创建时间

modified_time

String

数据源更新时间

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码： 200

OK

{
  "size" : 1,
  "total" : 1,
  "data-sources" : [ {
    "created_time" : "2020-09-19T07:10:12Z",
    "id" : "b71d74cd5889433bb90083f6fbc3adae",
    "modified_time" : "2020-09-19T07:10:12Z",
    "name" : "fdi_ds_demo",
    "status" : "new",
    "type" : "mysql",
    "url" : "jdbc:mysql://10.10.10.156:3306/apic?allowPublicKeyRetrieval=true&characterEncoding=UTF-8",
    "user" : "apictest"
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"
}

状态码： 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码： 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

状态码： 404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}

状态码： 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。