Creating a VPC Endpoint Client
Function
This API is used to create a VPC endpoint client. VPC connects to APIG, allowing you to call DataArts Fabric APIs using private domain names. This API is synchronous with no accompanying APIs or specific scenarios.
URI
POST /v1/access-clients
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Definition: Client name. Constraints: N/A. Range: 4 to 32 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A. |
vpc_id |
No |
String |
Definition: VPC ID. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A. |
subnet_id |
No |
String |
Definition: Subnet ID. The value is generated by the system when a subnet is created. Constraints: N/A. Range: 36 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A. |
subnet_ids |
No |
Array of strings |
Definition: Subnet group. Constraints: N/A. Range: [0, 100]. Default Value: N/A. |
access_connections |
No |
Array of AccessConnectionRequestBody objects |
Access connection list, which takes effect when the access mode is CUSTOM. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
vpcep_id |
No |
String |
Definition: VPC endpoint ID. Choose Clients in the navigation pane on the left. Click Create to create a client for access management. On the displayed page, click Buy VPC Endpoint in the upper right corner to create a VPC endpoint. Then, you can check the VPC endpoint ID. Constraints: N/A. Range: [0, 64]. Default Value: N/A. |
vpcep_service_name |
No |
String |
Definition: VPC endpoint service name. Constraints: N/A. Range: [0, 64]. Default Value: N/A. |
domain |
No |
String |
Definition: Access domain name. When accessing a LakeFormation API using an IP address, you need to add the HOST parameter to the request header and pass in the domain name. Constraints: N/A. Range: [0, 100]. Default Value: N/A. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: ID. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A. |
name |
String |
Definition: name. Constraints: N/A. Range: 1 to 64 characters. Only letters, numbers, hyphens (-), underscores (_), periods (.), and spaces are allowed. Default Value: N/A. |
status |
String |
Definition: Access status. Constraints: N/A. Range:
Default Value: N/A. |
vpc_id |
String |
Definition: VPC ID of a service access client. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value: N/A. |
subnet_ids |
Array of strings |
Definition: Subnet ID of a service access client. Use commas (,) to separate multiple subnets. Constraints: N/A. Range: [0, 100]. Default Value: N/A. |
access_connections |
Array of AccessConnectionInfo objects |
Definition: Access connection list. Constraints: N/A. Range: [0, 100]. Default value: N/A. |
create_time |
String |
Definition: Creation time. Constraints: N/A. Range: N/A. Default Value: N/A. |
Parameter |
Type |
Description |
---|---|---|
vpcep_id |
String |
Definition: VPC endpoint ID. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default value: N/A. |
subnet_id |
String |
Definition: Subnet ID. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default value: N/A. |
domain |
String |
Definition: Access domain name. When accessing a DataArts Fabric API using an IP address, you need to add the HOST parameter to the request header and pass in the domain name. Constraints: N/A. Range: 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default value: N/A. |
ip |
String |
Definition: IPv4 address. Constraints: Only IPv4 addresses are allowed. Range: N/A. Default value: N/A. |
owner |
String |
Definition: Owner. Constraints: N/A. Range: [1, 64]. Default Value: N/A. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A. |
error_msg |
String |
Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A. |
solution_msg |
String |
Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A. |
error_msg |
String |
Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A. |
solution_msg |
String |
Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A. |
error_msg |
String |
Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A. |
solution_msg |
String |
Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A. |
Status code: 408
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A. |
error_msg |
String |
Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A. |
solution_msg |
String |
Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Definition: Error code. Constraints: N/A. Range: 8 to 36 characters. Default Value: N/A. |
error_msg |
String |
Definition: Error message. Constraints: N/A. Range: 2 to 512 characters. Default Value: N/A. |
solution_msg |
String |
Definition: Solution description. Constraints: N/A. Range: 0 to 4,096 characters. Default Value: N/A. |
Example Requests
Create a VPC endpoint client. The request configuration is shown in the example.
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" } ] }
Example Responses
Status code: 200
An access client is created.
{ "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" }
Status code: 400
BadRequest
{ "error_code" : "common.01000001", "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException" }
Status code: 401
Unauthorized
{ "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" }
Status code: 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" }
Status code: 404
NotFound
{ "error_code" : "common.01000001", "error_msg" : "response status exception, code: 404" }
Status code: 408
Request Time-out
{ "error_code" : "common.00000408", "error_msg" : "timeout exception occurred" }
Status code: 500
InternalServerError
{ "error_code" : "common.00000500", "error_msg" : "internal error" }
Status Codes
Status Code |
Description |
---|---|
200 |
An access client is created. |
400 |
BadRequest |
401 |
Unauthorized |
403 |
Forbidden |
404 |
NotFound |
408 |
Request Time-out |
500 |
InternalServerError |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot