更新时间:2024-07-31 GMT+08:00
分享

获取数据源详情

功能介绍

获取数据源详情。

URI

GET /v1/{project_id}/connections/{connection_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:0

最大长度:128

connection_id

String

数据源ID。

最小长度:0

最大长度:100

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

工作空间ID,即控制台的项目ID。

最小长度:0

最大长度:128

X-Auth-Token

String

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

最小长度:0

最大长度:8192

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

数据源ID。

最小长度:1

最大长度:128

name

String

数据源名称。

最小长度:1

最大长度:512

description

String

数据源描述。

最小长度:0

最大长度:128

host

String

数据源IP或域名。

最小长度:1

最大长度:128

port

Integer

端口。

最小值:0

最大值:2147483647

server_list

String

服务列表。

最小长度:1

最大长度:512

database_name

String

数据库名称。

最小长度:1

最大长度:512

user_name

String

用户名。

最小长度:1

最大长度:64

url

String

jdbc连接url。

最小长度:0

最大长度:512

test_url

String

jdbc连接test_url。

最小长度:0

最大长度:512

password

String

连接数据库密码。

最小长度:0

最大长度:512

source_instance_id

String

关联云实例ID。

最小长度:0

最大长度:255

vpc_connection_id

String

关联云实例vpc_connection_id。

最小长度:0

最大长度:255

project_id

String

项目ID。

最小长度:0

最大长度:64

domain_id

String

用户domainId。

最小长度:0

最大长度:64

region_id

String

所属regionID。

最小长度:0

最大长度:64

work_space_id

String

所属工作空间ID。

最小长度:0

最大长度:64

extra

String

网络配置信息。

最小长度:0

最大长度:65535

config

DcConfigVO object

配置信息。

type

String

数据源类型:MySQL、PostgreSQL、DWS、OpenGauss、DLI、ClickHouse、API、Doris。

枚举值:

  • MySQL
  • PostgreSQL
  • DWS
  • OpenGauss
  • DLI
  • ClickHouse
  • API
  • Doris

source

String

数据源来源:

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

最小长度:1

最大长度:64

mode

String

模式.

最小长度:1

最大长度:64

default_schema

String

默认schema.

最小长度:0

最大长度:255

表4 DcConfigVO

参数

参数类型

描述

ssl

Boolean

ssl参数配置。

region_id

String

DLI归属regionId;当前不支持跨region,值只能是当前regionId。

最小长度:1

最大长度:20

catalog_name

String

数据目录名称,默认值:dli;DLI自有catalog值为dli。

缺省值:dli

最小长度:0

最大长度:64

catalog_type

String

数据目录类型,默认值:dil,枚举值:

  • dli:DLI自有catalog;
  • lakeformation:lakeformation的数据目录。

缺省值:dli

最小长度:0

最大长度:10

ds_project_id

String

DLI队列归属rpojectId。

最小长度:0

最大长度:100

queue_name

String

SQL队列。

最小长度:1

最大长度:200

auth_type

String

验证方式;AKSK。

枚举值:

  • AKSK

ds_ak

String

用户ak(验证方式为AKSK时必填)。

最小长度:0

最大长度:500

ds_sk

String

用户sk(验证方式为AKSK时必填)。

最小长度:0

最大长度:500

time_out

Integer

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

最小值:0

最大值:2147483647

protocol

String

协议:REST。

最小长度:0

最大长度:50

token_key

String

token key。

最小长度:0

最大长度:10000

token_value

String

token value。

最小长度:0

最大长度:2000

resp_param

Array of ResponseParamVO objects

返回参数。

数组长度:0 - 1000

param_example

String

API数据源参数示例。

最小长度:0

最大长度:1000

request_url

String

API数据源时,请求url。

最小长度:0

最大长度:1000

request_method

String

请求方式:GET、POST。

最小长度:0

最大长度:100

枚举值:

  • GET
  • POST

request_params

Array of RequestParamDto objects

请求参数列表。

数组长度:0 - 1000

表5 ResponseParamVO

参数

参数类型

描述

select

Boolean

是否选中当前参数。

json_path

String

json路径。

最小长度:0

最大长度:512

alias_name

String

参数别名。

最小长度:0

最大长度:512

field_type

String

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

最小长度:0

最大长度:100

param_name

String

参数名称。

最小长度:0

最大长度:32

表6 RequestParamDto

参数

参数类型

描述

location

String

位置。

最小长度:0

最大长度:100

value

Array of strings

参数值。

最小长度:0

最大长度:1000

数组长度:0 - 100

tag_id

String

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

最小长度:0

最大长度:128

param_name

String

参数名称。

最小长度:0

最大长度:500

alias_name

String

参数别名。

最小长度:0

最大长度:128

field_type

String

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

最小长度:0

最大长度:50

param_source

String

参数来源:custom、user、userGroup。

最小长度:0

最大长度:50

type

Boolean

是否加密。

请求示例

获取数据源详情。

GET /v1/{project_id}/connections/{connection_id}

响应示例

状态码: 200

数据源详情。

{
  "id" : "xxxxxxx3796649a185b012a96xxxxxxx",
  "name" : "xxx_gaussdbtest",
  "host" : "xxx.xx.x.xx",
  "port" : 8000,
  "server_list" : "xxx.xx.x.xx:xxxx",
  "database_name" : "gaussdb",
  "user_name" : "modernbi",
  "test_url" : "jdbc:gaussdb://xxx.xx.xx.xx:xxxx/gaussdb?socketTimeout=120&loginTimeout=5&ssl=true",
  "project_id" : "xxxxxxxb4dac4055888643b33xxxxxxx",
  "domain_id" : "xxxxxxxf3c90428fb22606b64xxxxxxx",
  "work_space_id" : "xxxxxxxea0764ffa850664804xxxxxxx",
  "extra" : "[{\"ip\": \"xxx.xx.x.xx\", \"port\": xxxx, \"channelType\": \"eip\"}]",
  "config" : {
    "ssl" : true
  },
  "type" : "DWS",
  "source" : "dws",
  "mode" : "multi-node",
  "default_schema" : "public",
  "creation_user" : "xxxxxa863a94b0ba2887b80dxxxxx",
  "creation_date" : 1700114987113,
  "creation_user_name" : "test_name",
  "update_user" : "xxxxxxxa863a94b0ba2887b80dcxxxxxxx",
  "update_user_name" : "test_name",
  "update_date" : 1701071948929
}

状态码

状态码

描述

200

数据源详情。

错误码

请参见错误码

相关文档