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

Enabling the VPC Endpoint Service

Function

The VPC endpoint service enables secure and reliable access across VPCs through a dedicated gateway, without exposing the network information of servers. This API is used to enable VPC endpoints for an Elasticsearch or OpenSearch cluster.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/open

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints N/A Range Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits. Default Value N/A
cluster_id	Yes	String	Definition ID of the cluster whose VPC endpoint you want to enable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints N/A Range The value is a UUID containing 36 characters. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
endpoint_with_dns_name	No	Boolean	Definition: Whether to enable private domain names. Constraints: N/A Value range: true: enabled. false: disabled. Default value: false
profession_vpcep	No	Boolean	Definition: Whether to create professional VPC endpoints. Constraints: N/A Value range: true: enabled. false: disabled. Default value: false
dualstack_enable	No	Boolean	Definition: Whether to enable IPv4/IPv6 dual-stack networking. Constraints: The IPv4/IPv6 dual-stack network can be enabled only when a professional VPC endpoint is created and the VPC of the cluster supports IPv6. Value range: true: enabled. false: disabled. Default value: false

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
action	String	Definition: Whether to enable VPC endpoints. Value range: createVpcepservice indicates that the endpoint is enabled.

Example Requests

Enable the VPC endpoint service.

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/vpcepservice/open

{
  "endpoint_with_dns_name" : true
}

Example Responses

Status code: 200

Request succeeded.

{
  "action" : "createVpcepservice"
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. Modify the request before retry.
409	The request could not be completed due to a conflict with the current state of the resource. The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
412	The server did not meet one of the preconditions contained in the request.

Error Codes

See Error Codes.

Parent topic: VPC Endpoint