文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 数据源/ 验证终端节点服务并创建终端节点 - VerifyAndCreateVpcEp
更新时间：2025-11-25 GMT+08:00
查看PDF
分享

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

功能介绍

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

ds_type

是

String

参数解释：

数据源类型。

取值范围：

  • MySQL

  • DWS

  • PostgreSQL

  • OpenGauss

  • HIVE

  • ClickHouse

  • API

vpc_ep_server_name

否

String

参数解释：

终端节点服务名称。

取值范围：

不涉及

vpc_ep_server_id

否

String

参数解释：

终端节点服务ID。

取值范围：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

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通道场景

请求示例

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

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

验证成功结果。

错误码

请参见错误码。

父主题： 数据源

相关文档