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

Updated on 2024-09-11 GMT+08:00

Online Debugging

CLI Examples

View PDF

Creating a VPC Endpoint

Function

This API is used to create a VPC endpoint for accessing a VPC endpoint service.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/vpc-endpoints

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Minimum: 1 Maximum: 64

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. Default: application/json

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
subnet_id	No	String	Note: This parameter is mandatory to create an interface VPC endpoint. The ID must be the ID of the subnet created in the VPC specified by vpc_id and in the format of UUID. For details, see the id field in the response information of the section "Querying Subnet Details" in the Virtual Private Cloud API Reference. This parameter is mandatory when you create a VPC endpoint for connecting an interface VPC endpoint service. Note: ● The subnet CIDR block of the VPC cannot overlap with 198.19.128.0/17. ● The destination address of the custom route in the VPC route table cannot overlap with 198.19.128.0/17. Minimum: 1 Maximum: 64
endpoint_service_id	Yes	String	Specifies the ID of the VPC endpoint service. You can obtain the ID of the VPC endpoint service to be connected by querying the section "VPCEP Service Overview". Minimum: 1 Maximum: 64
vpc_id	Yes	String	Specifies the ID of the VPC where the VPC endpoint is located. For details, see the id field in the response information of the section "Querying VPC Details" in the Elastic Cloud Server API Reference. Minimum: 1 Maximum: 64
enable_dns	No	Boolean	Specifies whether to create a domain name. ● true: A domain name is required. ● false: A domain name is not required. The default value is false. Note: When you create a VPC endpoint for connecting a gateway VPC endpoint service, no domain name is created if enable_dns is set to true or false. Default: false
tags	No	Array of TagList objects	Specifies the tag list. If there is no tag in the list, tags is taken as an empty array.
routetables	No	Array of strings	Specifies the IDs of route tables. For details, see the id field in the response information of the section "Querying a VPC Route" in the Virtual Private Cloud API Reference. This parameter is mandatory when you create a VPC endpoint for connecting a gateway VPC endpoint service. Note: If this parameter is not configured, use the default route table. Minimum: 0 Maximum: 64 Array Length: 1 - 10
port_ip	No	String	Specifies the IP address for accessing the associated VPC endpoint service. You can specify IP addresses for accessing the associated VPC endpoint service when creating a VPC endpoint. Only IPv4 addresses are supported. This parameter is mandatory when you create a VPC endpoint for connecting an interface VPC endpoint service. Minimum: 1 Maximum: 128
whitelist	No	Array of strings	Specifies whitelists added for controlling access to the VPC endpoint. IPv4 addresses or CIDR blocks can be specified to control access when you create a VPC endpoint. The whitelist is left blank by default. This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service. Minimum: 0 Maximum: 32
enable_whitelist	No	Boolean	Specifies whether access control is enabled.
description	No	String	Specifies the description field. The value can contain characters such as letters and digits, but cannot contain less than signs (<) and great than signs (>). Minimum: 0 Maximum: 512
policy_statement	No	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 Object Storage Service (OBS) and Scalable File Service (SFS) is set to true. Array Length: 0 - 10
policy_document	No	Object	Specifies the IAM 5.0 policies. Array Length: 0 - 20480
ip_version	No	String	Specifies the IP version of the VPC endpoint. Only professional VPC endpoints support this parameter. ipv4: The VPC endpoint IP address can only be an IPv4 address. dualstack: The VPC endpoint IP address can be an IPv4 or IPv6 address.
ipv6_address	No	String	Specifies the IPv6 address of the VPC endpoint service to be connected to. When creating a VPC endpoint, you can specify the IP address for the VPC endpoint service you will connect to. If you do not specify the IP address, the IP address generated by the system will be used. Only professional VPC endpoints support this parameter.

**Table 4** TagList
Parameter	Mandatory	Type	Description
key	No	String	Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. It cannot be left blank. It cannot contain equal signs (=), asterisks (), less than signs (<), greater than signs (>), backslashes (), commas (,), vertical bars (\|), and slashes (/), and the first and last characters cannot be spaces. Minimum: 1 Maximum: 128*
value	No	String	Specifies the tag key. A tag value contains a maximum of 43 Unicode characters and can be an empty string. It cannot contain equal signs (=), asterisks (), less than signs(<), greater than signs (>), backslashes (), commas (,), vertical bars (\|), and slashes (/), and the first and last characters cannot be spaces. Maximum: 255*

**Table 5** PolicyStatement
Parameter	Mandatory	Type	Description
Effect	Yes	String	Allow indicates that the VPC endpoint policy can be modified. Deny indicates that the VPC endpoint policy cannot be modified.
Action	Yes	Array of strings	Specifies OBS access permissions.
Resource	Yes	Array of strings	Specifies the OBS object.

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
id	String	Specifies the unique ID of the VPC endpoint. Minimum: 1 Maximum: 64
service_type	String	Specifies the type of the VPC endpoint service that the VPC endpoint is used to connect to. gateway: indicates VPC endpoint services that are configured by the O&M personnel. You can directly use them. interface: indicates cloud services configured by the O&M personnel and private services created by yourselves. You can directly use interface VPC endpoint services configured by the O&M personnel. You can query the public VPC endpoint services to view the VPC endpoint services that are configured by the O&M personnel and visible and accessible to all users. 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 of the VPC endpoint. Minimum: 1 Maximum: 64
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. Minimum: 1 Maximum: 64
enable_dns	Boolean	Specifies whether to create a domain name. true: Create a domain name. false: Do not create a domain name. Note When you create a VPC endpoint for connecting to a gateway VPC endpoint service, no domain name is created regardless of whether enable_dns is set to true or false.
subnet_id	String	Specifies the ID of the subnet in the VPC specified by vpc_id. The ID is in UUID format. Minimum: 1 Maximum: 64
vpc_id	String	Specifies the ID of the VPC where the VPC endpoint is to be created. Minimum: 1 Maximum: 64
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 the update time of the VPC endpoint. 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". Minimum: 1 Maximum: 64
tags	Array of TagList objects	Specifies the list of queried tags. 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. Minimum: 0 Maximum: 32
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, false will be returned. This parameter is available only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
routetables	Array of strings	Specifies the route table ID list. If this parameter is not specified, the ID of the default route table of the VPC is returned. This parameter is available when you create a VPC endpoint for connecting to a gateway VPC endpoint service. Minimum: 0 Maximum: 64
specification_name	String	Specifies the name of the specifications.
description	String	Provides supplementary information about the VPC endpoint. The description can contain letters and digits. Greater than symbols (<) and less than symbols (>) are not allowed. Minimum: 0 Maximum: 128
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. Array Length: 0 - 10
policy_document	Object	Specifies the IAM 5.0 policies. Array Length: 0 - 20480
enable_status	String	Specifies whether a VPC endpoint is available. enable: The VPC endpoint is available. disable: The VPC endpoint is not available.
endpoint_pool_id	String	(To be discarded) Specifies the ID of the cluster associated with the VPC endpoint. Minimum: 1 Maximum: 64
public_border_group	String	Specifies the public border group information about the pool corresponding to the VPC endpoint.
ipv6_address	String	Specifies the IPv6 address of the VPC endpoint. Only professional VPC endpoints support this parameter.

**Table 7** TagList
Parameter	Type	Description
key	String	Specifies the tag key. A tag key contains a maximum of 36 Unicode characters. It cannot be left blank. It cannot contain equal signs (=), asterisks (), less than signs (<), greater than signs (>), backslashes (), commas (,), vertical bars (\|), and slashes (/), and the first and last characters cannot be spaces. Minimum: 1 Maximum: 128*
value	String	Specifies the tag key. A tag value contains a maximum of 43 Unicode characters and can be an empty string. It cannot contain equal signs (=), asterisks (), less than signs(<), greater than signs (>), backslashes (), commas (,), vertical bars (\|), and slashes (/), and the first and last characters cannot be spaces. Maximum: 255*

**Table 8** 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.

Example Requests

Create a VPC endpoint without creating a domain name.

POST https://{endpoint}/v1/{project_id}/vpc-endpoints

{
  "subnet_id" : "5d1c1d71-2613-4274-b34e-d82af550f967",
  "vpc_id" : "4e65f8b1-306d-4522-8ecd-aa374000e2a4",
  "endpoint_service_id" : "813d9300-8473-405b-bfcd-f711117bad65",
  "enable_dns" : "false"
}

Example Responses

Status code: 200

The server has successfully processed the request.

{
  "id" : "492c776f-2cb9-40a2-9735-d7279ab2bbb6",
  "status" : "accepted",
  "ip" : "172.16.0.154",
  "tags" : [ ],
  "whitelist" : [ ],
  "marker_id" : 302010104,
  "active_status" : [ "active" ],
  "vpc_id" : "0da03835-1dcf-4361-9b87-34139d58dd59",
  "service_type" : "interface",
  "project_id" : "0605767a3300d5762fb7c0186d9e1779",
  "subnet_id" : "fb1b8b7e-f34c-4ff1-b3a7-221acef3b3aa",
  "enable_dns" : false,
  "created_at" : "2022-04-28T02:44:50Z",
  "updated_at" : "2022-04-28T02:56:15Z",
  "endpoint_service_id" : "8843fac2-bc01-445a-a822-c8124ff3968c",
  "endpoint_service_name" : "br-abc-aaa1.vm_test.8843fac2-bc01-445a-a822-c8124ff3968c",
  "enable_whitelist" : false,
  "specification_name" : "default",
  "endpoint_pool_id" : "501f4a3b-6f96-4309-97d1-e291b8ca5b96",
  "enable_status" : "enable",
  "public_border_group" : "center"
}

SDK Sample Code

The SDK sample code is as follows.

Create a VPC endpoint without creating a domain name.

      
       
         
         
           package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.vpcep.v1.region.VpcepRegion;
import com.huaweicloud.sdk.vpcep.v1.*;
import com.huaweicloud.sdk.vpcep.v1.model.*;


public class CreateEndpointSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        VpcepClient client = VpcepClient.newBuilder()
                .withCredential(auth)
                .withRegion(VpcepRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateEndpointRequest request = new CreateEndpointRequest();
        CreateEndpointRequestBody body = new CreateEndpointRequestBody();
        body.withEnableDns(false);
        body.withVpcId("4e65f8b1-306d-4522-8ecd-aa374000e2a4");
        body.withEndpointServiceId("813d9300-8473-405b-bfcd-f711117bad65");
        body.withSubnetId("5d1c1d71-2613-4274-b34e-d82af550f967");
        request.withBody(body);
        try {
            CreateEndpointResponse response = client.createEndpoint(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

          

        

      
     

Create a VPC endpoint without creating a domain name.

      
       
         
         
           # coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkvpcep.v1.region.vpcep_region import VpcepRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkvpcep.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = VpcepClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(VpcepRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateEndpointRequest()
        request.body = CreateEndpointRequestBody(
            enable_dns=False,
            vpc_id="4e65f8b1-306d-4522-8ecd-aa374000e2a4",
            endpoint_service_id="813d9300-8473-405b-bfcd-f711117bad65",
            subnet_id="5d1c1d71-2613-4274-b34e-d82af550f967"
        )
        response = client.create_endpoint(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

          

        

      
     

Create a VPC endpoint without creating a domain name.

      
       
         
         
           package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    vpcep "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpcep/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := vpcep.NewVpcepClient(
        vpcep.VpcepClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateEndpointRequest{}
	enableDnsCreateEndpointRequestBody:= false
	subnetIdCreateEndpointRequestBody:= "5d1c1d71-2613-4274-b34e-d82af550f967"
	request.Body = &model.CreateEndpointRequestBody{
		EnableDns: &enableDnsCreateEndpointRequestBody,
		VpcId: "4e65f8b1-306d-4522-8ecd-aa374000e2a4",
		EndpointServiceId: "813d9300-8473-405b-bfcd-f711117bad65",
		SubnetId: &subnetIdCreateEndpointRequestBody,
	}
	response, err := client.CreateEndpoint(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     