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

Modifying Public Network Access Bandwidth

Function

This API is used to modify the public network access bandwidth of an Elasticsearch or OpenSearch cluster.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/public/bandwidth

**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 bandwidth you want to modify. 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
band_width	Yes	BindPublicReqEipBandWidth object	Definition: Public network bandwidth. Constraints: N/A

**Table 3** 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

Request succeeded.

None

Example Requests

Modify public network access bandwidth.

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

{
  "band_width" : {
    "size" : 5
  },
  "is_auto_pay" : 1
}

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.

Parent topic: Public Network Access