获取数据源列表 - ListDataConnection

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

all

否

Boolean

参数解释：

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

约束限制：

不涉及

取值范围：

• true: 是

• false: 否

默认取值：

false

limit

否

Integer

参数解释：

返回条目数。

约束限制：

不涉及

取值范围：

[1,1000]

默认取值：

10

offset

否

Integer

参数解释：

分页查询偏移量。

约束限制：

不涉及

取值范围：

[0,1000]

默认取值：

0

name

否

String

参数解释：

数据源搜索值。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

type

否

String

参数解释：

数据源类型。

约束限制：

不涉及

取值范围：

• MySQL

• DWS

• PostgreSQL

• OpenGauss

• Doris

• HIVE

• ClickHouse

• DLI

• API

默认取值：

不涉及

sort_key

否

String

参数解释：

排序字段。

约束限制：

不涉及

取值范围：

• name：名称

• creation_date：创建时间

• update_date：更新时间

默认取值：

name

sort_dir

否

String

参数解释：

排序类型。

约束限制：

不涉及

取值范围：

• asc: 升序

• desc: 降序

默认取值：

asc

X-Workspace-Id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

page_data

Array of DataConnectionVO objects

分页数据。

count

Long

参数解释：

数据总数。

取值范围：

不涉及

id

String

参数解释：

数据源ID。

取值范围：

不涉及

name

String

参数解释：

数据源名称。

取值范围：

不涉及

description

String

参数解释：

数据源描述。

取值范围：

不涉及

host

String

参数解释：

数据源ip或域名。

取值范围：

不涉及

port

Integer

参数解释：

端口。

取值范围：

不涉及

server_list

String

参数解释：

服务列表。

取值范围：

不涉及

database_name

String

参数解释：

数据库名称。

取值范围：

不涉及

user_name

String

参数解释：

用户名。

取值范围：

不涉及

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。

取值范围：

不涉及

config

DcConfigVO object

配置信息。

type

String

参数解释：

数据源类型。

取值范围：

• MySQL

• DWS

• PostgreSQL

• OpenGauss

• Doris

• HIVE

• ClickHouse

• DLI

• API

source

String

参数解释：

数据源来源。

取值范围：

• rds：云服务RDS数据源

• dws：DWS集群数据源

• mrs：云服务MRS数据源

• gaussdb：云服务GaussDB数据源

• public：公网接入方式数据源

• restapi：API数据源

• dli：云服务DLI数据源

• endpoint-service：终端节点服务接入方式数据源

mode

String

参数解释：

模式。

取值范围：

不涉及

default_schema

String

参数解释：

默认schema。

取值范围：

不涉及

vpc_connection

Array of VpcConnectionVO objects

vpc连接实例信息。

ssl

Boolean

参数解释：

ssl参数配置。

取值范围：

不涉及

region_id

String

参数解释：

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

取值范围：

不涉及

catalog_name

String

参数解释：

数据目录名称。

取值范围：

dli：DLI自有catalog值为dli

catalog_type

String

参数解释：

数据目录类型。

取值范围：

• dli：DLI自有catalog

• lakeformation：lakeformation的数据目录

ds_project_id

String

参数解释：

队列归属projectId。

取值范围：

不涉及

queue_name

String

参数解释：

SQL队列。

取值范围：

不涉及

auth_type

String

参数解释：

验证方式。

取值范围：

不涉及

ds_ak

String

参数解释：

用户ak。

取值范围：

不涉及

ds_sk

String

参数解释：

用户sk。

取值范围：

不涉及

time_out

Integer

参数解释：

请求超时时间。

取值范围：

不涉及

protocol

String

参数解释：

协议。

取值范围：

不涉及

token_key

String

参数解释：

token key。

取值范围：

不涉及

token_value

String

参数解释：

token value。

取值范围：

不涉及

resp_param

Array of ResponseParamVO objects

返回参数。

param_example

String

参数解释：

API数据源参数示例。

取值范围：

不涉及

request_url

String

参数解释：

请求url。

取值范围：

不涉及

request_method

String

参数解释：

请求方式。

取值范围：

不涉及

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_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

参数解释：

是否加密。

取值范围：

不涉及

id

String

参数解释：

连接实例ID。

取值范围：

不涉及

create_date

Long

参数解释：

连接实例创建时间戳。

取值范围：

不涉及

create_user

String

参数解释：

创建者ID。

取值范围：

不涉及

create_user_name

String

参数解释：

创建者名称。

取值范围：

不涉及

update_date

Long

参数解释：

连接实例更新时间戳。

取值范围：

不涉及

update_user

String

参数解释：

更新者ID。

取值范围：

不涉及

update_user_name

String

参数解释：

更新者名称。

取值范围：

不涉及

project_id

String

参数解释：

项目ID。

取值范围：

不涉及

domain_id

String

参数解释：

用户domainID。

取值范围：

不涉及

ds_type

String

参数解释：

数据源类型。

取值范围：

• MySQL

• DWS

• PostgreSQL

• OpenGauss

• Doris

• HIVE

• ClickHouse

• API

vpc_ep_server_id

String

参数解释：

终端节点服务ID。

取值范围：

不涉及

vpc_ep_server_name

String

参数解释：

终端节点服务名称。

取值范围：

不涉及

vpc_ep_client_id

String

参数解释：

终端节点ID。

取值范围：

不涉及

vpc_ep_client_status

String

参数解释：

终端节点状态。

取值范围：

• accepted：已接受

• pendingAcceptance：待审批

scene

String

参数解释：

网络场景。

取值范围：

dii-app_to_data-source：DataArts Insight至数据源vpcep通道场景

200

数据源列表详情。