Help Center/ VPC Endpoint/ API Reference/ API/ VPC Endpoints/ Updating a VPC Endpoint

Updated on 2025-10-28 GMT+08:00

View PDF

Updating a VPC Endpoint

Function

This API is used to update or delete the whitelist of a 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, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
vpcep:endpoints:update	Write	endpoints *	vpcep:VpceServiceName vpcep:VpceServiceOrgPath vpcep:VpceServiceOwner g:ResourceTag/<tag-key>	-	-
		routeTable	-
		subnet	-

URI

PUT /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}

**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 ID of the VPC endpoint.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.
Content-Type	No	String	Specifies the MIME type of the request body. 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
whitelist	No	Array of strings	Specifies the whitelist updated or deleted for controlling access to VPC endpoints. The value can be an IPv4 address or a CIDR block. Note the following when configuring this parameter: If the value is not left blank, the whitelist is updated with new records. If the value is left blank, all original whitelist records are deleted. The whitelist is left blank by default.
enable_whitelist	No	Boolean	Specifies whether access control is enabled. true: Access control is enabled. false: Access control is disabled. The default value is false.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Specifies the unique ID of the VPC endpoint.
service_type	String	Specifies the type of the VPC endpoint service that the VPC endpoint is used to connect to. gateway: indicates the VPC endpoint services that are configured by the O&M personnel. You can use them directly without creating them by yourselves. interface: indicates the cloud services configured by the O&M personnel and private services created by yourselves. You cannot configure these cloud services, but can use them. You can query the public VPC endpoint services to view the VPC endpoint services that are visible and accessible to all users and are configured by the O&M personnel. You can create interface VPC endpoint services.
status	String	Specifies the status of the VPC endpoint. pendingAcceptance: The VPC endpoint is to be accepted. creating: The VPC endpoint is being created. accepted: The VPC endpoint has been accepted. rejected: The VPC endpoint has been rejected. failed: The VPC endpoint failed to be created. deleting: The VPC endpoint is being deleted.
ip	String	Specifies the IP address for accessing the associated VPC endpoint service. This parameter is returned only under the following conditions: You query a VPC endpoint for accessing an interface VPC endpoint service. Connection approval is enabled for the VPC endpoint service, and the connection has been approved. status of the VPC endpoint can be accepted or rejected. The rejected status only appears when the VPC endpoint is accepted and then rejected.
active_status	Array of strings	Specifies the account status. frozen: The account is frozen. active: The account is unfrozen.
endpoint_service_name	String	Specifies the name of the VPC endpoint service.
marker_id	Integer	Specifies the packet ID of the VPC endpoint.
endpoint_service_id	String	Specifies the ID of the VPC endpoint service.
enable_dns	Boolean	Specifies whether to create a domain name. true: A domain name will be created. false: No domain names will be created. Note: When you create a VPC endpoint for connecting to a gateway VPC endpoint service, no domain names will be created regardless of whether enable_dns is set to true or false.
dns_names	Array of strings	Specifies the domain name for accessing the associated VPC endpoint service. This parameter is available when enable_dns is set to true.
subnet_id	String	Specifies the ID of the subnet in the VPC specified by vpc_id. The ID is in UUID format.
vpc_id	String	Specifies the ID of the VPC where the VPC endpoint is to be created.
created_at	String	Specifies when the VPC endpoint was created. The UTC time format YYYY-MM-DDTHH:MM:SSZ is used.
updated_at	String	Specifies when the VPC endpoint was updated. The UTC time format YYYY-MM-DDTHH:MM:SSZ is used.
project_id	String	Specifies the project ID. For details about how to obtain the project ID, see "Obtaining a Project ID".
tags	Array of TagList objects	Specifies the tag list. If no tag is matched, an empty array is returned.
whitelist	Array of strings	Specifies the whitelist for controlling access to the VPC endpoint. If you do not specify this parameter, an empty whitelist will be returned. This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
enable_whitelist	Boolean	Specifies whether access control is enabled. true: Access control is enabled. false: Access control is disabled. If you do not specify this parameter, access control is disabled. This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
policy_statement	Array of PolicyStatement objects	Specifies the policy of the gateway VPC endpoint. This parameter is only available when enable_policy of the VPC endpoint services for OBS and SFS is set to true.
policy_document	Object	Specifies the policy of the VPC endpoint. This parameter is only available when enable_policy of the VPC endpoint services is set to true. The default value indicates full access permission. (This parameter is not available for the VPC endpoint services for OBS and SFS.)

**Table 5** TagList
Parameter	Type	Description
key	String	Specifies the tag key. key cannot be left blank. A key can contain 1 to 128 characters. A key can contain UTF-8 letters, digits, spaces, and the following special characters _ . : = + - @ Keys cannot start with _sys_ because it indicates a system tag. A key cannot start or end with a space.
value	String	Specifies the tag value. A value can contain 0 to 255 characters. A value can contain UTF-8 letters, digits, spaces, and the following special characters _ . : / = + - @ A value can be an empty string.

**Table 6** PolicyStatement
Parameter	Type	Description
Effect	String	Allow indicates that the VPC endpoint policy can be modified. Deny indicates that the VPC endpoint policy cannot be modified.
Action	Array of strings	Specifies OBS access permissions.
Resource	Array of strings	Specifies the OBS object.
Condition	Object	Conditions for the statement to take effect.

Example Requests

Updating a VPC endpoint and setting whitelist to 192.168.1.1 and 192.168.1.2 and enable_whitelist to true

PUT https://{endpoint}/v1/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2- d380272eed83

{ 
  "whitelist":
             [
              "192.168.1.1",
              "192.168.1.2"
             ],
  "enable_whitelist":true,
}

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
  "service_type" : "interface",
  "status" : "accepted",
  "ip" : "10.32.xx.xx",
  "marker_id" : 322312312312,
  "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
  "enable_dns" : true,
  "endpoint_service_name" : "test123",
  "endpoint_service_id" : "test123",
  "project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
  "whitelist" : [ "192.168.1.1", "192.168.1.2" ],
  "enable_whitelist" : true,
  "created_at" : "2022-04-14T09:35:47Z",
  "updated_at" : "2022-04-14T09:36:47Z",
  "tags" : [ {
    "key" : "test1",
    "value" : "test1"
  } ]
}