Updated on 2026-04-03 GMT+08:00

Creating a VPC Endpoint

Function

Create a VPC endpoint.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v5/{project_id}/host-management/vpc-endpointes

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

host_id_list

No

Array of strings

Definition

Server ID list.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

vpc_list

No

Array of VpcAndSubNet objects

Definition

VPC list.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 4 VpcAndSubNet

Parameter

Mandatory

Type

Description

vpc_id

Yes

String

Definition

VPC ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

subnet_id_list

Yes

Array of strings

Definition

Subnet ID list.

Constraints

N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Create a VPC endpoint.

GET https://{endpoint}/v5/{project_id}/host-management/vpc-endpointes?enterprise_project_id=all_granted_ep

{
  "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ],
  "vpc_list" : [ {
    "vpc_id" : "789-1111111",
    "subnet_id_list" : [ "777777-1111" ]
  } ]
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.