Help Center/ FunctionGraph/ API Reference/ APIs/ Function Lifecycle Management/ Creating a VPC Endpoint
Updated on 2024-12-02 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a VPC Endpoint

Function

This API is used to create a VPC endpoint. (Currently, this API is supported only in CN North-Beijing4 and CN East-Shanghai1.)

URI

POST /v2/{project_id}/fgs/vpc-endpoint

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

Message body type (format).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

flavor

No

String

Endpoint specifications. By default, large specifications are used.

xrole

No

String

Agency used to create the endpoint.

vpc_id

Yes

String

ID of the VPC to connect to the endpoint.

subnet_id

Yes

String

ID of the subnet to connect to the endpoint.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

endpoints

Array of strings

IP addresses.

address

String

Domain name.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Use an agency to create a VPC endpoint with VPC a938xxxx and subnet a4a1xxxx.

POST https://{Endpoint}/v2/{project_id}/fgs/vpc-endpoint

{
  "vpc_id" : "a938xxxx-7xxx-4xxx-bxxx-cee915xxxxxx",
  "subnet_id" : "a4a1xxxx-9xxx-4xxx-8xxx-bb46f7xxxxxx",
  "flavor" : "default",
  "xrole" : "xxx"
}

Example Responses

Status code: 200

ok

{
  "endpoints" : [ ],
  "address" : "https://xx"
}

Status Codes

Status Code

Description

200

ok

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.

500

Internal server error.

Error Codes

See Error Codes.