Help Center/ Cloud Search Service/ API Reference/ API V1/ VPC Endpoint/ Disabling the VPC Endpoint Service

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

View PDF

Disabling the VPC Endpoint Service

Function

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

After the VPCEP service is disabled, users can no longer access the cluster via the VPCEP IP address or a private domain name. If you disable the VPCEP service and then re-enable it, the VPCEP IP address or private domain name may change. Exercise caution.

Calling Method

For details, see Calling APIs.

URI

PUT /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/close

**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 Value range: Project ID of the account. Default value: N/A
cluster_id	Yes	String	Definition: ID of the cluster whose VPC endpoint you want to disable. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints: N/A Value range: Cluster ID. Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

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

Example Requests

Disable the VPC endpoint service.

PUT https://{Endpoint}/v1.0/{project_id}/clusters/5c77b71c-5b35-4f50-8984-76387e42451a/vpcepservice/close

Example Responses

Status code: 200

Request succeeded.

{
  "action" : "deleteVpcepservice"
}

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.