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

**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 ACTIVE: in use. PENDING_CREATE: creating. ERROR: The policy has the same rule as another policy added to the same listener.
bandwidth	Integer	Definition Bandwidth information. Range A positive integer greater than or equal to 0
vpc_id	String	Definition VPC ID. Range N/A

Example Requests

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

Example Responses

Status code: 200

ELB list queried.

{
  "elbs" : [ {
    "id" : "1e6e0b66-6223-4523-bfd9-033c88b4ce9f",
    "name" : "loadbalancer5",
    "description" : "simple lb",
    "bandwidth" : 0,
    "vip_address" : "192.168.0.222",
    "admin_state_up" : true,
    "vpc_id" : "c9f1171e-dc90-4ae9-bf22-f9736983ce2d"
  } ]
}

Status Codes

Status Code	Description
200	ELB list queried.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.