Viewing the Details of a Load Balancer
Function
This API is used to view the details of a load balancer.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A |
loadbalancer_id |
Yes |
String |
Definition: Specifies the load balancer ID. Constraints: N/A Range: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-). |
loadbalancer |
LoadBalancer object |
Definition: Provides details about the load balancer. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Specifies the load balancer ID. Range: N/A |
description |
String |
Definition: Provides supplementary information about the load balancer. Range: N/A |
provisioning_status |
String |
Definition: Specifies the provisioning status of the load balancer. Range:
|
admin_state_up |
Boolean |
Definition: Specifies whether the load balancer is enabled. Range:
|
provider |
String |
Definition: Specifies the provider of the load balancer. The value is fixed to vlb. Range: N/A |
pools |
Array of PoolRef objects |
Definition: Lists the IDs of backend server groups associated with the load balancer. |
listeners |
Array of ListenerRef objects |
Definition: Lists the IDs of listeners associated with the load balancer. |
operating_status |
String |
Definition: Specifies the operating status of the load balancer. Range:
|
name |
String |
Definition: Specifies the load balancer name. Range: N/A |
project_id |
String |
Definition: Specifies the ID of the project where the load balancer is used. Range: N/A |
vip_subnet_cidr_id |
String |
Definition: Specifies the ID of the IPv4 subnet where the load balancer is located. This subnet is also called the frontend subnet. Range: N/A |
vip_address |
String |
Definition: Specifies the private IPv4 address of the load balancer. Range: N/A |
vip_port_id |
String |
Definition: Specifies the ID of the port bound to the private IPv4 address of the load balancer. Range: N/A |
tags |
Array of Tag objects |
Definition: Specifies the tags added to the load balancer. |
created_at |
String |
Definition: Specifies the time when the load balancer was created. Range: The value must be in the format of yyyy-MM-dd'T'HH:mm:ss'Z'. |
updated_at |
String |
Definition: Specifies the time when the load balancer was updated. Range: The value must be in the format of yyyy-MM-dd'T'HH:mm:ss'Z'. |
guaranteed |
Boolean |
Definition: Specifies whether the load balancer is a dedicated load balancer. Range:
|
vpc_id |
String |
Definition: Specifies the ID of the VPC where the load balancer is located. Range: N/A |
eips |
Array of EipInfo objects |
Definition: Specifies the EIP bound to the load balancer.
NOTE:
This parameter has the same meaning as publicips.
|
ipv6_vip_address |
String |
Definition: Specifies the IPv6 address of the load balancer. Range: N/A |
ipv6_vip_virsubnet_id |
String |
Definition: Specifies the ID of the IPv6 subnet where the load balancer is located. This subnet is also called the frontend subnet. Range: N/A |
ipv6_vip_port_id |
String |
Definition: Specifies the ID of the port bound to the IPv6 address of the load balancer. Range: N/A |
availability_zone_list |
Array of strings |
Definition: Specifies the list of AZs where the load balancers are created. Range: N/A |
enterprise_project_id |
String |
Definition: Specifies the ID of the enterprise project. Range:
|
billing_info |
String |
Definition: Provides resource billing information. Range:
This parameter is unsupported. Please do not use it. |
l4_flavor_id |
String |
Definition: Specifies the ID of a flavor at Layer 4. If the current load balancer is an elastic flavor instance, this parameter defines the maximum elastic flavor at Layer 4. Range: N/A |
l4_scale_flavor_id |
String |
Definition: Specifies the ID of an elastic flavor at Layer 4. Range: N/A
NOTE:
This parameter has been discarded. Do not use it.
|
l7_flavor_id |
String |
Definition: Specifies the ID of a flavor at Layer 7. If the current load balancer is an elastic flavor instance, this parameter defines the maximum elastic flavor at Layer 7. Range: N/A |
l7_scale_flavor_id |
String |
Definition: Specifies the ID of an elastic flavor at Layer 7. Range: N/A
NOTE:
This parameter has been discarded. Do not use it.
|
gw_flavor_id |
String |
Definition: Specifies the flavor ID of the gateway load balancer. Range: N/A This parameter is unsupported. Please do not use it. |
loadbalancer_type |
String |
Definition: Specifies the load balancer type. Range:
This parameter is unsupported. Please do not use it. |
publicips |
Array of PublicIpInfo objects |
Definition: Specifies the EIP bound to the load balancer.
NOTE:
This parameter has the same meaning as eips.
|
global_eips |
Array of GlobalEipInfo objects |
Definition: Specifies the global EIP bound to the load balancer. This parameter is unsupported. Please do not use it. |
elb_virsubnet_ids |
Array of strings |
Definition: Specifies the network IDs of subnets on the downstream plane. Range: N/A |
elb_virsubnet_type |
String |
Definition: Specifies the type of the subnet on the downstream plane. Range:
|
ip_target_enable |
Boolean |
Definition: Specifies whether to add backend servers that are not in the load balancer's VPC. If you set it to true, you can associate servers in a VPC connected through a VPC peering connection, in a VPC connected through a cloud connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using server IP addresses. Range:
|
frozen_scene |
String |
Definition: Specifies the scenario where the load balancer is frozen. If there are multiple scenarios, separate them with commas (,). Range:
This parameter is unsupported. Please do not use it. |
deletion_protection_enable |
Boolean |
Definition: Specifies whether to enable deletion protection. This parameter is returned only when the deletion protection is enabled in the current region. Range:
This parameter is unsupported. Please do not use it. |
autoscaling |
AutoscalingRef object |
Definition: Specifies information about elastic scaling. If elastic scaling is enabled, the load balancer flavors can be automatically adjusted based on incoming traffic. This parameter is unsupported. Please do not use it. |
public_border_group |
String |
Definition: Specifies the public border group. Range:
This parameter is unsupported. Please do not use it. |
charge_mode |
String |
Definition: Specifies the charge mode of the load balancer. Range:
This parameter is unsupported. Please do not use it. |
service_lb_mode |
String |
Definition: Specifies load balancer mode. Range:
This parameter is unsupported. Please do not use it. |
instance_type |
String |
Definition: Specifies the internal service to which the load balancer belongs. Range: N/A This parameter is unsupported. Please do not use it. |
instance_id |
String |
Definition: Specifies the ID of the instance with which the load balancer is associated. Range: N/A This parameter is unsupported. Please do not use it. |
proxy_protocol_extensions |
Array of ProxyProtocolExtension objects |
Definition: Specifies the proxy protocol extension. This parameter is unsupported. Please do not use it. |
waf_failure_action |
String |
Definition: Specifies traffic distributing policies when the WAF is faulty. Range: discard indicates traffic will not be distributed. forward indicates traffic will be distributed to the default backend servers. This parameter is unsupported. Please do not use it. |
log_group_id |
String |
Definition: Specifies the ID of the log group that is associated with the load balancer. Range: N/A |
log_topic_id |
String |
Definition: Specifies the ID of the log topic that is associated with the load balancer. Range: N/A |
custom_qos_limit |
CustomQosLimit object |
Definition: Specifies the rate limit information of the ELB flavors. Range: N/A This parameter is unsupported. Please do not use it. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Specifies the backend server group ID. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Specifies the listener ID. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Definition: Specifies the tag key. Range: N/A |
value |
String |
Definition: Specifies the tag value. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
eip_id |
String |
Definition: Specifies the EIP ID. Range: N/A |
eip_address |
String |
Definition: Specifies the EIP. Range: N/A |
ip_version |
Integer |
Definition: Specifies the IP address version. Range:
|
Parameter |
Type |
Description |
---|---|---|
publicip_id |
String |
Definition: Specifies the EIP ID. Range: N/A |
publicip_address |
String |
Definition: Specifies the EIP. Range: N/A |
ip_version |
Integer |
Definition: Specifies the IP address version. Range:
|
Parameter |
Type |
Description |
---|---|---|
global_eip_id |
String |
Definition: Specifies the ID of the global EIP. Range: N/A |
global_eip_address |
String |
Definition: Specifies the global EIP. Range: N/A |
ip_version |
Integer |
Definition: Specifies the IP address version. Range:
|
Parameter |
Type |
Description |
---|---|---|
enable |
Boolean |
Definition: Specifies whether to enable elastic scaling for the load balancer. Range:
|
min_l7_flavor_id |
String |
Definition: Specifies the ID of the minimum elastic flavor at Layer 7. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
vip_address |
String |
Definition: Specifies the IPv4 address. Constraints: N/A Range: N/A Default value: N/A |
ipv6_vip_address |
String |
Definition: Specifies the IPv6 address. Constraints: N/A Range: N/A Default value: N/A |
extension |
Extension object |
Definition: Specifies the proxy protocol extension. Constraints: N/A |
Parameter |
Type |
Description |
---|---|---|
ep_id |
String |
Definition: Specifies the VPC endpoint ID. Constraints: N/A Range: N/A Default value: N/A |
ep_service_id |
String |
Definition: Specifies the VPC endpoint service ID. Constraints: N/A Range: N/A Default value: N/A |
Parameter |
Type |
Description |
---|---|---|
l4 |
L4Limit object |
Definition: Specifies the rate limit information of the ELB flavors at Layer 4. |
l7 |
L7Limit object |
Definition: Specifies the rate limit information of the ELB flavors at Layer 7. |
Example Requests
Querying the details of a given load balancer
GET https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers/3dbde7e5-c277-4ea3-a424-edd339357eff
Example Responses
Status code: 200
Successful request.
{ "loadbalancer" : { "id" : "3dbde7e5-c277-4ea3-a424-edd339357eff", "project_id" : "060576782980d5762f9ec014dd2f1148", "name" : "elb-l4-no-delete", "description" : null, "vip_port_id" : "f079c7ee-65a9-44ef-be86-53d8927e59be", "vip_address" : "10.0.0.196", "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ ], "pools" : [ { "id" : "1d864dc9-f6ef-4366-b59d-7034cde2328f" }, { "id" : "c0a2e4a1-c028-4a24-a62f-e721c52f5513" }, { "id" : "79308896-6169-4c28-acbc-e139eb661996" } ], "tags" : [ ], "provider" : null, "created_at" : "2019-12-02T09:55:11Z", "updated_at" : "2019-12-02T09:55:11Z", "vpc_id" : "70711260-9de9-4d96-9839-0ae698e00109", "enterprise_project_id" : "0", "availability_zone_list" : [ ], "ipv6_vip_address" : null, "ipv6_vip_virsubnet_id" : null, "ipv6_vip_port_id" : null, "publicips" : [ ], "elb_virsubnet_ids" : [ "ad5d63bf-3b50-4e88-b4d9-e94a59aade48" ], "eips" : [ ], "guaranteed" : true, "billing_info" : null, "l4_flavor_id" : "e5acacda-f861-404e-9871-df480c49d185", "l4_scale_flavor_id" : null, "l7_flavor_id" : null, "l7_scale_flavor_id" : null, "vip_subnet_cidr_id" : "396d918a-756e-4163-8450-3bdc860109cf", "deletion_protection_enable" : false, "autoscaling" : { "enable" : true, "min_l7_flavor_id" : "0c8cf29d-51cb-4c1d-8e25-1c61cf5c2b00" }, "public_border_group" : "center" }, "request_id" : "1a47cfbf-969f-4e40-8c0e-c2e60b14bcac" }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.