Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoints/ Upgrading a VPC Endpoint
Updated on 2025-12-08 GMT+08:00

Upgrading a VPC Endpoint

Function

This API is used to upgrade a basic VPC endpoint to a professional VPC endpoint.

Calling Method

For details, see Calling APIs.

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 /v2/{project_id}/vpc-endpoints/{vpc_endpoint_id}/upgrade

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

vpc_endpoint_id

Yes

String

Specifies the VPC endpoint ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

No

String

Specifies the MIME type of the body in the request. Default value application/json is recommended. For APIs used to upload objects or images, the MIME type varies depending on the flow type.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Specifies the upgrade action.

The default value is start, indicating that the upgrade starts.

Response Parameters

Status code: 202

Request processed.

None

Example Requests

Upgrading a basic VPC endpoint to a professional VPC endpoint

POST https://{endpoint}/v2/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2- d380272eed88/upgrade

Example Responses

None

Status Codes

Status Code

Description

202

Request processed.

Error Codes

See Error Codes.