文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 数据源/ 验证终端节点服务并创建终端节点
更新时间：2024-07-31 GMT+08:00
在线调试
CLI示例
查看PDF
分享

验证终端节点服务并创建终端节点

功能介绍

验证终端节点服务并创建终端节点。

URI

POST /v1/{project_id}/connections/vpc-endpoint

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：0

最大长度：128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

是

String

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

最小长度：0

最大长度：128

X-Auth-Token

是

String

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

最小长度：0

最大长度：8192
表3 请求Body参数

参数

是否必选

参数类型

描述

ds_type

是

String

数据源类型：MySQL、PostgreSQL、DWS、OpenGauss、HIVE、ClickHouse、Doris。

最小长度：1

最大长度：32

vpc_ep_server_name

否

String

终端节点服务名称。终端节点服务ID为空时必填。

最小长度：0

最大长度：200

vpc_ep_server_id

否

String

终端节点服务ID。终端节点服务名称为空时必填。

最小长度：0

最大长度：64

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

id

String

连接实例ID。

最小长度：0

最大长度：36

create_date

Long

连接实例创建时间戳。

最小值：0

最大值：9223372036854774807

create_user

String

创建者ID。

最小长度：0

最大长度：32

create_user_name

String

创建者名称。

最小长度：0

最大长度：255

update_date

Integer

连接实例更新时间戳。

最小值：0

最大值：9223372036854774807

update_user

String

更新者ID。

最小长度：0

最大长度：64

update_user_name

String

更新者名称。

最小长度：0

最大长度：255

project_id

String

项目ID。

最小长度：0

最大长度：36

domain_id

String

用户domainID。

最小长度：0

最大长度：64

ds_type

String

数据源类型：MySQL、PostgreSQL、DWS、OpenGauss、HIVE、ClickHouse、Doris。

最小长度：1

最大长度：32

vpc_ep_server_id

String

终端节点服务ID。

最小长度：0

最大长度：64

vpc_ep_server_name

String

终端节点服务名称。

最小长度：0

最大长度：255

vpc_ep_client_id

String

终端节点ID。

最小长度：0

最大长度：64

vpc_ep_client_status

String

终端节点状态。

  • accepted：已接受
  • pendingAcceptance：待审批

最小长度：0

最大长度：64

scene

String

网络场景。

  • dii-app_to_data-source：DataArtsInsight至数据源vpcep通道场景

最小长度：0

最大长度：255

请求示例

验证终端节点服务并创建终端节点。

POST /v1/{project_id}/connections/vpc-endpoint
{
  "ds_type" : "DWS",
  "vpc_ep_server_name" : "cn-xxxx-x.DII-INGEST-LB.xxxxxx-31cf-4e27-xxxx-4b71db9b82fb"
}

响应示例

状态码： 200

验证成功结果。

{
  "create_date" : 1714962072863,
  "create_user" : "xxxxx",
  "create_user_name" : "xxxx",
  "update_date" : 1714962072863,
  "update_user" : "xxxx",
  "update_user_name" : "xxxx",
  "id" : "8a8080c08xxxxxf4bb485240001",
  "project_id" : "9c3043axxxx88643b3xxxxxx27",
  "domain_id" : "d22f8axxx428fb2260xxxxx823",
  "ds_type" : "DWS",
  "vpc_ep_server_id" : "xxxxx-31cf-4e27-xxxxx-4b71db9b82fb",
  "vpc_ep_server_name" : "cn-xxxx-x.DII-xxxx-LB.716b4ee7-xxxx-4e27-852e-xxxxxxx",
  "vpc_ep_client_id" : "xxxxxx-62be-4479-xxxxx-7379d6dafc40",
  "vpc_ep_client_status" : "accepted",
  "scene" : "dii-app_to_data-source"
}

状态码

状态码

描述

200

验证成功结果。

错误码

请参见错误码。

父主题： 数据源

相关文档