Help Center> Cloud Search Service> API Reference> VPC Endpoint> Enabling the VPC Endpoint Service
Updated on 2023-04-14 GMT+08:00

Enabling the VPC Endpoint Service

Function

This API is used to enable the VPC endpoint service.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

endpointWithDnsName

No

Boolean

Enable the VPC endpoint.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

action

String

Operations. The fixed value is createVpcepservice, indicating that the VPC endpoint is enabled.

Example Requests

{
  "endpointWithDnsName" : 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.