Updated on 2026-09-02 GMT+08:00

Disabling Public Network Access

Function

After an Elasticsearch/OpenSearch cluster is configured with public access, you can use this API to disable public access.

After public access is disabled, the cluster cannot be accessed through a public IP address. When public access is re-enabled after being disabled, the public IP address of the cluster may change. Proceed with caution.

Calling Method

For details, see Calling APIs.

URI

PUT /v1.0/{project_id}/clusters/{cluster_id}/public/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

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 public network access you want to disable. 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

eip

No

UnBindPublicReqEipReq object

Definition:

Public network access information.

Constraints:

N/A.

Table 3 UnBindPublicReqEipReq

Parameter

Mandatory

Type

Description

bandWidth

No

BindPublicReqEipBandWidth object

Definition:

Public network bandwidth.

Constraints:

N/A

Table 4 BindPublicReqEipBandWidth

Parameter

Mandatory

Type

Description

size

Yes

Integer

Definition:

Public network bandwidth, in Mbit/s.

Constraints:

N/A

Value range:

1-200

Default value:

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

action

String

Definition:

Disable public network access.

Value range:

unbindZone: Public network access disabled successfully.

Example Requests

Disable public network access.

PUT https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/public/close

{
  "eip" : {
    "bandWidth" : {
      "size" : 5
    }
  }
}

Example Responses

Status code: 200

Request succeeded.

{
  "action" : "unbindZone"
}

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.