Help Center/ Cloud Search Service/ API Reference/ API V1/ Load Balancing/ Querying Dedicated Load Balancers Supported by a Cluster
Updated on 2025-11-28 GMT+08:00
View PDF

Querying Dedicated Load Balancers Supported by a Cluster

Function

This API is used to query the dedicated load balancers supported by an Elasticsearch or OpenSearch cluster.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/loadbalancers

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

Value range:

Project ID of the account.

Default value:

N/A

cluster_id

Yes

String

Definition:

ID of the cluster to be queried. For details about how to obtain the cluster ID, see Obtaining the Cluster ID.

Constraints:

N/A

Value range:

Cluster ID.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

loadbalancers

Array of LoadbalancersResource objects

Definition:

List of dedicated load balancers.
Table 3 LoadbalancersResource

Parameter

Type

Description

id

String

Definition:

Load balancer ID.

Value range:

N/A

name

String

Definition:

Load balancer name.

Value range:

N/A

l7_flavor_id

String

Definition:

Layer-7 protocol ID.

Value range:

N/A

ip_target_enable

Boolean

Definition:

Whether to enable the cross-VPC backend.

Value range:

  • true: Enable the cross-VPC backend.

  • false: Disable the cross-VPC backend.

Example Requests

Query dedicated load balancers supported by a cluster.

GET https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/loadbalancers

Example Responses

Status code: 200

Request succeeded.

{
  "loadbalancers" : [ {
    "id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6268",
    "name" : "elb-css",
    "l7_flavor_id" : "9c8c2425-e061-4bf8-ac65-cd1db92b18e1",
    "ip_target_enable" : true
  }, {
    "id" : "5d45faad-6cb3-479b-96b8-3e2de0cc6269",
    "name" : "elb-b832",
    "l7_flavor_id" : "9c8c2425-e061-4bf8-ac65-cd1db92b18e1",
    "ip_target_enable" : true
  } ]
}

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