Querying Load Balancers
Function
This API is used to query load balancers and display them in a list.
URI
GET /v1.0/{project_id}/elbaas/loadbalancers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
Response
- Response parameters
Table 2 Parameter description Parameter
Type
Description
loadbalancers
Array
Lists the load balancers.
instance_num
String
Specifies the number of load balancers.
Table 3 loadbalancers parameter description Parameter
Type
Description
vip_address
String
Specifies the private IP address of the load balancer.
update_time
String
Specifies the time when the load balancer was updated.
create_time
String
Specifies the time when the load balancer was created.
id
String
Specifies the load balancer ID.
status
String
- Specifies the load balancer status.
- The value can be ACTIVE, PENDING_CREATE, or ERROR.
bandwidth
Integer
Specifies the bandwidth (Mbit/s).
vpc_id
String
Specifies the VPC ID.
admin_state_up
Integer
vip_subnet_id
String
This parameter is unavailable now.
type
String
Specifies the network type of the load balancer. The value is External.
name
String
Specifies the load balancer name.
description
String
Provides supplementary information about the load balancer.
security_group_id
String
- Specifies the security group ID.
- null is displayed for this parameter when type is set to External.
- Example response
{ "loadbalancers": [ { "vip_address": "192.144.62.114", "update_time": "2015-09-14 02:34:32", "create_time": "2015-09-14 02:34:32", "id": "0b07acf06d243925bc24a0ac7445267a", "status": "ACTIVE", "bandwidth": 1, "security_group_id": null, "vpc_id": "f54a3ffd-7a55-4568-9e3d-f0ff2d46a107", "admin_state_up": 1, "vip_subnet_id": null, "type": "External", "name": "MY_ELB", "description": null } ], "instance_num": "1" }
Status Code
- Normal
- Error
Status Code
Message
Description
400
badRequest
Request error.
401
unauthorized
Authentication failed.
403
userDisabled
You do not have the permission to perform the operation.
404
Not Found
The requested page does not exist.
500
authFault
System error.
503
serviceUnavailable
The service is unavailable.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot