All Products
Search
Document Center

ENS:DescribeLoadBalancers

Last Updated:Mar 12, 2024

Queries Edge Load Balancer (ELB) instances.

Operation description

  • 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
EnsRegionIdstringNo

The ID of the Edge Node Service (ENS) node.

cn-guangzhou-10
ServerIdstringNo

The ID of the backend server.

i-5f67ffjc004wwz0t****
LoadBalancerStatusstringNo

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.
InActive
LoadBalancerIdstringNo

The ID of the ELB instance.

lb-5q73cv04zeyh43lh74lp4****
LoadBalancerNamestringNo

The name of the ELB instance.

example
NetworkIdstringNo

The ID of the network.

n-5s9ayrxsd9hszrlt5fgv2****
VSwitchIdstringNo

The ID of the vSwitch.

vsw-5sy773iy25rulsmgskmba****
AddressstringNo

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

10.0.0.8
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Valid values: 10 to 100.

100

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

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

The page number.

1
PageSizeinteger

The number of entries per page. Default value: 10. Valid values: 10 to 100.

100
TotalCountinteger

The total number of entries returned.

6
LoadBalancersobject []

The returned ELB instances.

LoadBalancerIdstring

The ID of the ELB instance.

lb-5snthcyu1x10g7tywj7iu****
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.
InActive
Addressstring

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

10.10.10.10
EnsRegionIdstring

The ID of the ENS node.

cn-wuhan-telecom
NetworkIdstring

The ID of the network.

n-5rz0rj1caexauilpsjx0w****
VSwitchIdstring

The ID of the vSwitch.

vsw-5rllcjb3ol6duzjdnbm1om****
CreateTimestring

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

2021-05-06T11:13:41Z
AddressIPVersionstring

The version of the IP address. 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",
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 6,
  "LoadBalancers": {
    "LoadBalancer": [
      {
        "LoadBalancerId": "lb-5snthcyu1x10g7tywj7iu****",
        "LoadBalancerName": "example",
        "LoadBalancerStatus": "InActive",
        "Address": "10.10.10.10",
        "EnsRegionId": "cn-wuhan-telecom",
        "NetworkId": "n-5rz0rj1caexauilpsjx0w****",
        "VSwitchId": "vsw-5rllcjb3ol6duzjdnbm1om****",
        "CreateTime": "2021-05-06T11:13:41Z",
        "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