All Products
Search
Document Center

Server Load Balancer:DescribeRegions

Last Updated:Feb 22, 2024

Queries the regions in which Network Load Balancer (NLB) is available.

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
ServiceCodestringNo

The service code. Set the value to nlb.

nlb
AcceptLanguagestringNo

The supported natural language. Valid values:

  • zh-CN: Chinese
  • en-US (default): English
  • ja: Japanese
en-US
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must ensure that it is unique among all requests. ClientToken can contain only ASCII characters.

Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.
123e4567-e89b-12d3-a456-426655440000

Response parameters

ParameterTypeDescriptionExample
object

RpcResponse

RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
Regionsobject []

A list of regions.

LocalNamestring

The name of the region.

us-east-1
RegionEndpointstring

The endpoint of the region service.

nlb.cn-hangzhou.aliyuncs.com
RegionIdstring

The ID of the region.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "Regions": [
    {
      "LocalName": "us-east-1",
      "RegionEndpoint": "nlb.cn-hangzhou.aliyuncs.com",
      "RegionId": "cn-hangzhou"
    }
  ]
}

Error codes

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.
    Error Codes 400 change
2023-09-26The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400