Help Center/ Cloud Search Service/ API Reference/ APIs/ VPC Endpoint/ Enabling the VPC Endpoint Service

Updated on 2025-05-22 GMT+08:00

View PDF

Enabling the VPC Endpoint Service

This API is used to enable the VPCEP service for a cluster.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
cluster_id	Yes	String	ID of the cluster whose VPC endpoint you want to enable.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
endpointWithDnsName	No	Boolean	Enable the VPC endpoint.
professionVpcep	No	Boolean	Create a professional VPC endpoint. true: enabled. false: disabled.
dualstackEnable	No	Boolean	Whether to enable the IPv4/IPv6 dual-stack network. 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. true: enabled. false: disabled.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
action	String	Parameter description: Action. The fixed value is createVpcepservice, indicating that the VPC endpoint is enabled.

Enable the VPC endpoint service.

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/vpcepservice/open

{
  "endpointWithDnsName" : true
}

Status code: 200

Request succeeded.

{
  "action" : "createVpcepservice"
}

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.