Updated on 2026-10-21 GMT+08:00

Querying the List of ELBs That Can Be Bound to a Cluster

Function

This API is used to query the list of ELBs that can be bound to a cluster.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/clusters/{cluster_id}/elbs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
cluster_id	Yes	String	Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints The value must be a valid DWS cluster ID. Range It is a 36-digit UUID. Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
elbs	Array of ClusterElbInfo objects	Definition ELB list. Range N/A
count	Integer	Definition Total number of records. Range N/A

**Table 3** ClusterElbInfo
Parameter	Type	Description
id	String	Definition ELB ID. Range N/A
cluster_id	String	Definition Cluster ID. Range It is a 36-digit UUID.
name	String	Definition ELB name. Range N/A
description	String	Definition ELB description. Range N/A
vip_address	String	Definition ELB address. Range N/A
vip_subnet_id	String	Definition Subnet ID. Range N/A
tenant_id	String	Definition Tenant ID. Range N/A
type	String	Definition ELB type. Range Internal: dedicated External: shared
admin_state_up	Boolean	Definition ELB status. Range true: in use false: not in use
bandwidth	Integer	Definition Bandwidth information. Range An integer greater than or equal to 0
vpc_id	String	Definition VPC ID. Range N/A
ip_target_enable	Boolean	Definition Whether cross-VPC binding is supported. Range N/A

Example Requests

Query the list of ELBs that can be bound to a cluster.

get https://{Endpoint}/v2/4cf650fd46704908aa071b4df2453e1e/clusters/194408fa-9d41-435c-a140-91edcf5fe519/elbs

Example Responses