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

Enabling or Disabling Load Balancers for a Cluster

Function

CSS can interconnect with ELB. This API is used to enable or disable load balancers for an Elasticsearch or OpenSearch cluster.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers/es-switch

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

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
enable	Yes	Boolean	Definition Enables or disables an Elasticsearch or OpenSearch load balancer. Constraints N/A Range true: enabled. false: disabled. Default Value N/A
agency	No	String	Definition Agency name for configuring load balancing. Constraints This parameter is mandatory when enable is set to true. Range The agency name can contain at most 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. Default Value N/A
elb_id	No	String	Definition Load balancer ID. For details about how to obtain the load balancer ID, see . Constraints This parameter is mandatory when enable is set to true. Range N/A Default Value N/A
type	No	String	Definition Load balancer type. Constraints This parameter is not required for an observability cluster. Range searchTool: Enables or disables an Elasticsearch or OpenSearch load balancer. Default Value searchTool

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
elb_id	String	Definition: Load balancer ID. Value range: N/A.

Example Requests

Enable the load balancer.

POST https://{Endpoint}/v1.0/{project_id}/clusters/58ee0f27-70b3-47e0-ac72-9e3df6cd15cd/loadbalancers/es-switch

{
  "enable" : true,
  "elb_id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268",
  "agency" : "css_elb_agency"
}

Example Responses

Status code: 200

Request succeeded.

{
  "elb_id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268"
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. Modify the request instead of retrying.
409	The request cannot be processed due to a conflict. This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.
412	The server does not meet one of the requirements that the requester puts on the request.

Error Codes

See Error Codes.

Parent topic: Load Balancing