Modifying the VPCEP Service Whitelist of a Cluster
Function
To control IP addresses and CIDR blocks that can access a VPC endpoint, configure a whitelist. When or after purchasing a VPC endpoint, you can enable or disable access control for the VPC endpoint, and add or delete a whitelist record. This API is used to modify the VPC endpoint whitelist for an Elasticsearch or OpenSearch cluster.
Calling Method
For details, see Calling APIs.
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/vpcepservice/permissions
| 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 to be modified. 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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| vpc_permissions | Yes | Array of strings | Definition List of whitelist entries (account IDs). For details about how to obtain account IDs, see Querying Projects Based on Specified Criteria. Constraints N/A |
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Modify the endpoint service whitelist.
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/vpcepservice/permissions
{
"vpc_permissions" : [ "dffef70c1db243cbb373e45791165281" ]
} Example Responses
None
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.