更新时间:2025-04-28 GMT+08:00
分享

创建vpcep客户端

功能介绍

创建vpcep客户端。VPC打通APIG,使用户可以通过内网域名调用到fabric接口。此接口为同步接口,无配套使用接口和特殊场景。

调试

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

URI

POST https://localhost.com/v1/access-clients

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

name

String

  • 参数解释:客户端名称。

  • 约束限制:不涉及。

  • 取值范围:长度为[4,32]的英文字符、数字和中划线(-)的组合。

  • 默认取值:不涉及。

vpc_id

String

  • 参数解释:虚拟私有云id。

  • 约束限制:不涉及。

  • 取值范围:长度为[1,64]的英文字符、数字和中划线(-)的组合。

  • 默认取值:不涉及。

subnet_id

String

  • 参数解释:子网ID。创建子网时由系统生成。

  • 约束限制:不涉及。

  • 取值范围:长度为[36]的英文字符、数字和中划线(-)的组合。

  • 默认取值:不涉及。

subnet_ids

Array of strings

  • 参数解释:所属子网组。

  • 约束限制:不涉及。

  • 取值范围:[0,100]。

  • 默认取值:不涉及。

access_connections

Array of AccessConnectionRequestBody objects

接入连接列表,当接入模式为CUSTOM模式时生效。

表2 AccessConnectionRequestBody

参数

是否必选

参数类型

描述

vpcep_id

String

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

  • 约束限制:不涉及。

  • 取值范围:[0,64]。

  • 默认取值:不涉及。

vpcep_service_name

String

  • 参数解释:终端节点服务名称。

  • 约束限制:不涉及。

  • 取值范围:[0,64]。

  • 默认取值:不涉及。

domain

String

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

  • 约束限制:不涉及。

  • 取值范围:[0,100]。

  • 默认取值:不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

String

  • 参数解释:id。

  • 约束限制:不涉及。

  • 取值范围:长度为[1,64]的英文字符、数字和中划线(-)的组合。

  • 默认取值:不涉及。

name

String

参数解释:名称。

约束限制:不涉及。

取值范围:长度为[1,64]的中文、字母、数字、下划线(_)、中划线(-)、点(.)、空格的组合。

默认取值:不涉及。

status

String

  • 参数解释:接入状态。

  • 约束限制:不涉及。

  • 取值范围

    • CREATING:创建中;

    • RUNNING:运行中;

    • DELETING:删除中;

    • DELETED:已删除;

  • 默认取值:不涉及。

vpc_id

String

  • 参数解释:服务接入客户端的vpcID。

  • 约束限制:不涉及。

  • 取值范围:长度为[1,64]的英文字符、数字和中划线(-)的组合。

  • 默认取值:不涉及。

subnet_ids

Array of strings

  • 参数解释:服务接入客户端的子网ID,多个子网用,连接。

  • 约束限制:不涉及。

  • 取值范围:[0,100]。

  • 默认取值:不涉及。

access_connections

Array of AccessConnectionInfo objects

  • 参数解释:接入连接列表。

  • 约束限制:不涉及。

  • 取值范围:[0,100]。

  • 默认取值:不涉及

create_time

String

  • 参数解释:创建时间。

  • 约束限制:不涉及。

  • 取值范围:不涉及。

  • 默认取值:不涉及。

表4 AccessConnectionInfo

参数

参数类型

描述

vpcep_id

String

  • 参数解释:vpcep id。

  • 约束限制:不涉及。

  • 取值范围:长度为[1,64]的英文字符、数字和中划线(-)的组合。

  • 默认取值:不涉及

subnet_id

String

  • 参数解释:subnet_id id。

  • 约束限制:不涉及。

  • 取值范围:长度为[1,64]的英文字符、数字和中划线(-)的组合。

  • 默认取值:不涉及

domain

String

  • 参数解释:接入域名,通过IP接入访问fabric API时,需在请求头中添加HOST参数并传入该域名。

  • 约束限制:不涉及。

  • 取值范围:长度为[1,64]的英文字符、数字和中划线(-)的组合。

  • 默认取值:不涉及

ip

String

  • 参数解释:ipv4地址。

  • 约束限制:ipv4地址。

  • 取值范围:不涉及。

  • 默认取值:不涉及

owner

String

  • 参数解释:拥有者。

  • 约束限制:不涉及。

  • 取值范围:长度[1,64]。

  • 默认取值:不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:不涉及。

  • 取值范围:长度为[8,36]个字符。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[2,512]个字符。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[0,4096]个字符。

  • 默认取值:不涉及。

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:不涉及。

  • 取值范围:长度为[8,36]个字符。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[2,512]个字符。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[0,4096]个字符。

  • 默认取值:不涉及。

状态码:404

表7 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:不涉及。

  • 取值范围:长度为[8,36]个字符。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[2,512]个字符。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[0,4096]个字符。

  • 默认取值:不涉及。

状态码:408

表8 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:不涉及。

  • 取值范围:长度为[8,36]个字符。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[2,512]个字符。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[0,4096]个字符。

  • 默认取值:不涉及。

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释:错误码。

  • 约束限制:不涉及。

  • 取值范围:长度为[8,36]个字符。

  • 默认取值:不涉及。

error_msg

String

  • 参数解释:错误描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[2,512]个字符。

  • 默认取值:不涉及。

solution_msg

String

  • 参数解释:解决方案描述。

  • 约束限制:不涉及。

  • 取值范围:长度为[0,4096]个字符。

  • 默认取值:不涉及。

请求示例

创建vpcep客户端。具体请求配置如样例所示。

POST https://{endpoint}/v1/access-clients

{
  "name" : "zzh_test001",
  "vpc_id" : "050e154d-9954-4929-b6d3-12af7c9213ac",
  "subnet_id" : "string",
  "subnet_ids" : [ "0d86d58d-d864-47ce-8dbd-5487ff1d59ba" ],
  "access_connections" : [ {
    "vpcep_id" : "string",
    "vpcep_service_name" : "string",
    "domain" : "string"
  } ]
}

响应示例

状态码:200

创建接入客户端的响应体。

{
  "id" : "f7670aea-36a1-4bdf-ae99-963c33324370",
  "name" : "name",
  "status" : "RUNNING",
  "vpc_id" : "f18a378a-f26b-461d-985f-3f904e4cc544",
  "subnet_ids" : [ "1e9a3f25-0f1f-40c4-8ef9-e4a8dd4d1e53" ],
  "access_connections" : [ {
    "vpcep_id" : "1851896e-3731-4072-8b4a-33e38ed2207b",
    "domain" : "1e9a3f25-0f1f-40c4-8ef9-e4a8dd4d1e53",
    "ip" : "192.168.0.57",
    "owner" : "0676610f3a0a4c2c80c50bea7ddf18c1"
  } ],
  "create_time" : "2025-01-08T01:53:30.000+00:00"
}

状态码:400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码:401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码:403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码:404

NotFound

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码:408

Request Time-out

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码:500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

创建接入客户端的响应体。

400

BadRequest

401

Unauthorized

403

Forbidden

404

NotFound

408

Request Time-out

500

InternalServerError

错误码

请参见错误码

相关文档