文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ Console/ 接入管理/ 创建服务接入客户端
更新时间：2024-10-22 GMT+08:00
查看PDF
分享

创建服务接入客户端

功能介绍

创建服务接入客户端。 其他限制： 同一个实例下默认最多创建20个接入客户端。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/instances/{instance_id}/access-clients

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目编号。获取方法，请参见获取项目ID。

instance_id

是

String

LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

租户token。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

客户端名称。只能包含字母、数字、下划线和中划线，且长度为4到32个字符。

access_mode

否

String

接入模式， SYSTEM：系统默认模式，由系统自动创建vpcep连接，也是推荐方式。该模式下vpc_id、subnet_id必填。 CUSTOM：定制模式，由外部服务自行创建vpcep连接，适用于跨租户场景等。该模式下access_connections必填。不建议使用，使用接入租户相关接口代替。

枚举值：

  • SYSTEM

  • CUSTOM

vpc_id

否

String

VPC ID，即虚机私有云ID。可以在 接入管理-创建客户端-前往VPC创建 进行创建。

subnet_id

否

String

子网ID。创建子网时由系统生成。例如8c6721b5-78d1-4c3c-97b1-8421da139ffc。

subnet_ids

否

Array of strings

多个子网ID集合。优先使用subnet_ids，当该字段为空时，使用subnet_id，两个字段不能同时为空。

access_connections

否

Array of AccessConnectionRequestBody objects

接入连接列表，当接入模式为CUSTOM模式时生效。
表4 AccessConnectionRequestBody

参数

是否必选

参数类型

描述

vpcep_id

否

String

虚拟私有云终端节点ID。在 接入管理-创建客户端-前往VPC创建-VPC终端节点 创建和查看。

vpcep_service_name

否

String

终端节点服务名称。最大长度为64个字符。

domain

否

String

接入域名，通过IP接入访问Lakeformation API时，需在请求头中添加HOST参数并传入该域名。

响应参数

状态码： 202

表5 响应Body参数

参数

参数类型

描述

id

String

客户端ID。

name

String

客户端名称。

access_mode

String

接入模式：SYSTEM、CUSTOM、AUTO。

枚举值：

  • SYSTEM

  • CUSTOM

  • AUTO

status

String

客户端状态：CREATING、RUNNING、DELETING、DELETED、CREATE_FAIL、DELETE_FAIL。

枚举值：

  • CREATING

  • RUNNING

  • DELETING

  • DELETED

  • CREATE_FAIL

  • DELETE_FAIL

vpc_id

String

VPC ID。

subnet_id

String

子网ID。

subnet_ids

Array of strings

多个子网ID集合。

access_connections

Array of AccessConnectionInfo objects

接入连接列表。

create_time

String

实例创建时间戳。
表6 AccessConnectionInfo

参数

参数类型

描述

vpcep_id

String

虚拟私有云终端节点ID。在接入管理-创建客户端-前往VPC创建-VPC终端节点 创建和查看。

subnet_id

String

子网ID。

ip

String

接入IP。

owner

String

拥有者。

domain

String

接入域名，通过IP接入访问Lakeformation API时，需在请求头中添加HOST参数并传入该域名。

请求示例

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/access-clients

{
  "name" : "name-example",
  "vpc_id" : "vpc-example",
  "subnet_id" : "subnet-example"
}

响应示例

状态码： 202

Created

{
  "id" : "gs23xxxxxxxxxxxxxxxxxxxxxxxxxxxxfgs2",
  "name" : "lakeformation_client",
  "access_mode" : "SYSTEM",
  "vpc_id" : "d3fcxxxxxxxxxxxxxxxxxxxxxxxxxxxx8f1e",
  "subnet_id" : "d3fcxxxxxxxxxxxxxxxxxxxxxxxxxxxx8f1e",
  "status" : "CREATING"
}

状态码

状态码

描述

202

Created

错误码

请参见错误码。

父主题： 接入管理