Queries regions that support Network Load Balancer (NLB) instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeRegions

The operation that you want to perform. Set the value to DescribeRegions.

ServiceCode String No nlb

The service code. Set the value to nlb.

AcceptLanguage String No en-US

The supported natural language. Valid values:

  • zh-CN: Chinese
  • en-US (default): English
  • ja: Japanese
ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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.

Response parameters

Parameter Type Example Description
RequestId String CEF72CEB-54B6-4AE8-B225-F876FF7BA984

The ID of the request.

Regions Array of Region

A list of regions.

LocalName String China (Hangzhou)

The name of the region.

RegionEndpoint String nlb.cn-hangzhou.aliyuncs.com

The endpoint of the region service.

RegionId String cn-hangzhou

The ID of the region.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeRegions
&ServiceCode=200
&AcceptLanguage=zh-CN
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeRegionsResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <Regions>
        <LocalName>China (Hangzhou)</LocalName>
        <RegionEndpoint>nlb.cn-hangzhou.aliyuncs.com</RegionEndpoint>
        <RegionId>cn-hangzhou</RegionId>
    </Regions>
</DescribeRegionsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "Regions" : [ {
    "LocalName":"China (Hangzhou)",
    "RegionEndpoint" : "nlb.cn-hangzhou.aliyuncs.com",
    "RegionId" : "cn-hangzhou"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.