All Products
Search
Document Center

ENS:DescribeLoadBalancerAttribute

Last Updated:Mar 12, 2024

Queries detailed information about an Edge Load Balancer (ELB) instance.

Operation description

Note
  • You can call this operation up to 100 times per second per account.

  • You can call this operation up to 10 times per second per user.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LoadBalancerIdstringYes

The ID of the ELB instance.

lb-5rcvo1n1t3hykfhhjwjgq****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
LoadBalancerIdstring

The ID of the ELB instance.

lb-5rcvo1n1t3hykfhhjwjgqp****
LoadBalancerNamestring

The name of the ELB instance.

example
LoadBalancerStatusstring

The status of the ELB instance. Valid values:

  • Active (default): The listener for the instance can forward the received traffic based on the rule.
  • InActive: The listener for the instance does not forward the received traffic.
Active
EnsRegionIdstring

The ID of the ENS node.

cn-chengdu-telecom
Addressstring

The IP address that the ELB instance uses to provide services.

192.168.0.1
NetworkIdstring

The ID of the network.

n-5rwbi3g9zvgxcsiufwhw8****
VSwitchIdstring

The ID of the vSwitch.

vsw-5s78m2pdr9osa0j64bn78****
Bandwidthinteger

The maximum bandwidth of the elastic IP address (EIP). Default value: 5. Valid values: 5 to 10000. Unit: Mbit/s.

2000
LoadBalancerSpecstring

The specifications of the ELB instance.

elb.s2.medium
CreateTimestring

The time when the ELB instance was created. The time is displayed in UTC.

2019-05-21T12:22:00Z
EndTimestring

The time when the ELB instance was disabled.

2020-05-21T12:22:00Z
ListenerPortsarray

The frontend ports that are used by the ELB instance.

string

The frontend port that is used by the ELB instance.

80
BackendServersobject []

The backend servers.

ServerIdstring

The ID of the backend server.

i-5vb5h5njxiuhn48a****
Ipstring

The IP address of the backend server.

192.168.0.5
Portstring

The port that is used by the backend server.

0
Typestring

The type of the backend server.

ens
Weightinteger

The weight of the backend server.

100
ListenerPortsAndProtocolsobject []

The frontend ports and protocols that are used by the ELB instance.

ListenerPortinteger

The listener port of the instance.

8080
ListenerProtocolstring

The listener protocol.

tcp
Descriptionstring

The description of the listener.

test
ListenerForwardstring

Indicates whether the listener is enabled.

off
ForwardPortinteger

The destination listening port to which requests are forwarded.

0
AddressIPVersionstring

The IP version of the ELB instance. Valid values: ipv4 and ipv6.

ipv4
PayTypestring

The billing method. Valid values:

  • PrePaid: subscription.
  • PostPaid: pay-as-you-go. Only this billing method is supported.
PostPaid

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "LoadBalancerId": "lb-5rcvo1n1t3hykfhhjwjgqp****",
  "LoadBalancerName": "example",
  "LoadBalancerStatus": "Active",
  "EnsRegionId": "cn-chengdu-telecom",
  "Address": "192.168.0.1",
  "NetworkId": "n-5rwbi3g9zvgxcsiufwhw8****",
  "VSwitchId": "vsw-5s78m2pdr9osa0j64bn78****",
  "Bandwidth": 2000,
  "LoadBalancerSpec": "elb.s2.medium",
  "CreateTime": "2019-05-21T12:22:00Z",
  "EndTime": "2020-05-21T12:22:00Z",
  "ListenerPorts": [
    "80"
  ],
  "BackendServers": [
    {
      "ServerId": "i-5vb5h5njxiuhn48a****",
      "Ip": "192.168.0.5\n",
      "Port": "0",
      "Type": "ens",
      "Weight": 100
    }
  ],
  "ListenerPortsAndProtocols": [
    {
      "ListenerPort": 8080,
      "ListenerProtocol": "tcp",
      "Description": "test",
      "ListenerForward": "off",
      "ForwardPort": 0
    }
  ],
  "AddressIPVersion": "ipv4",
  "PayType": "PostPaid"
}

Error codes

HTTP status codeError codeError message
400ens.interface.errorAn error occurred while call the API.
400NoPermissionPermission denied.
400InvalidParameter.%sThe specified field %s invalid. Please check it again.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-22The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400