获取数据源列表

project_id

是

String

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

all

否

Boolean

是否返回全部数据源列表。

limit

否

Integer

返回最大条数。

offset

否

Integer

偏移量。

name

否

String

数据源搜索值（按名称模糊匹配）。

type

否

String

参数解释：

数据源类型。

示例：MySQL，指定当前对接的数据源类型为MySQL，涉及查询时会使用MySQL驱动包。

约束限制：

不涉及

取值范围：

以下枚举值：

• MySQL；
• DWS：GaussDB(DWS)对应的数据源类型；
• PostgreSQL；
• OpenGauss：GaussDB对应的数据源类型；
• Doris；
• HIVE；
• ClickHouse；
• API：API数据对应数据源类型。

默认取值：

不涉及

sort_key

否

String

排序字段：支持name、creation_date、update_date。

sort_dir

否

String

排序类型：ASC、DESC。

枚举值：

• ASC
• DESC

X-Workspace-Id

是

String

工作空间ID。获取方法请参见获取工作空间ID。

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

page_data

Array of DataConnectionVO objects

分页数据。

数组长度：0 - 2147483647

count

Long

数据总数。

id

String

数据源ID。

name

String

数据源名称。

description

String

数据源描述。

host

String

数据源ip或域名。

port

Integer

端口。

server_list

String

服务列表。

database_name

String

数据库名称。

user_name

String

用户名。

url

String

jdbc连接url。

test_url

String

jdbc连接test_url。

password

String

连接数据库密码。

source_instance_id

String

关联云实例id。

vpc_connection_id

String

关联云实例vpc_connection_id。

project_id

String

项目ID。

domain_id

String

用户domainId。

region_id

String

所属regionID。

work_space_id

String

所属工作空间ID。

extra

String

网络配置信息。

config

DcConfigVO object

配置信息。

type

String

参数解释：

数据源类型。

示例：MySQL，指定当前对接的数据源类型为MySQL，涉及查询时会使用MySQL驱动包。

约束限制：

不涉及

取值范围：

以下枚举值：

• MySQL；
• DWS：GaussDB(DWS)对应的数据源类型；
• PostgreSQL；
• OpenGauss：GaussDB对应的数据源类型；
• Doris；
• HIVE；
• ClickHouse；
• API：API数据对应数据源类型。

默认取值：

不涉及

source

String

数据源来源。枚举值：

• rds：云服务RDS数据源；
• dws：DWS集群数据源；
• mrs：云服务MRS数据源；
• gaussdb：云服务GaussDB数据源；
• public：公网接入方式数据源；
• restapi：API数据源；
• endpoint-service：终端节点服务接入方式数据源。

mode

String

模式。

default_schema

String

默认schema。

ssl

Boolean

ssl参数配置。

region_id

String

归属regionId；当前不支持跨region，值只能是当前regionId。

catalog_name

String

数据目录名称；默认值：dli；DLI自有catalog值为dli。

catalog_type

String

数据目录类型，默认值：dil，枚举值：

• dli：DLI自有catalog；
• lakeformation：lakeformation的数据目录。

ds_project_id

String

DLI队列归属rpojectId。

queue_name

String

SQL队列。

auth_type

String

验证方式；AKSK。

枚举值：

• AKSK

ds_ak

String

用户ak（验证方式为AKSK时必填）。

ds_sk

String

用户sk（验证方式为AKSK时必填）。

time_out

Integer

API数据源时，请求超时时间。

protocol

String

协议：REST。

token_key

String

token key。

token_value

String

token value。

resp_param

Array of ResponseParamVO objects

返回参数。

param_example

String

API数据源参数示例。

request_url

String

API数据源时，请求url。

request_method

String

请求方式：GET、POST。

枚举值：

• GET
• POST

request_params

Array of RequestParamDto objects

请求参数列表。

select

Boolean

是否选中当前参数。

json_path

String

json路径。

alias_name

String

参数别名。

field_type

String

参数类型：String、Long、Decimal、DateTime、Bool。

param_name

String

参数名称。

location

String

位置。

value

Array of strings

参数值。

tag_id

String

标签ID，当param_source为user时必填。

param_name

String

参数名称。

alias_name

String

参数别名。

field_type

String

参数类型：String、Long、Decimal、List<String>、List<Long>、List<Decimal>、DateTime、Bool、PageIndex、PageNum。

param_source

String

参数来源：custom、user、userGroup。

type

Boolean

是否加密。

200

数据源列表详情。