You need to enable JavaScript to run this app.
TrafficRoute DNS Suite

TrafficRoute DNS Suite

  • Documentation
    • TrafficRoute DNS SuiteVolcanoEngine PrivateZoneAPI ReferenceDomain APIsListRegions
Copy page
Download PDF
Domain APIs
ListRegions
Copy page
Download PDF
ListRegions

Gets the list of supported regions.

Usage

  • Rate limit: 100 calls per second.

Request

  • Method: GET
  • URL: https://private-zone.volcengineapi.com/?Action=ListRegions?Version=2022-06-01

Request Parameters

In addition to the following parameters, you also need to include the authentication parameters.

Query

NameTypeRequiredExampleDescription
ActionStringYesListRegionsThe name of the API. The value of this parameter is ListRegions.
VersionStringYes2022-06-01The version of the API. The value of this parameter is 2022-06-01.
TagStringNoecsService type.
  • ecs: List of regions that support the ECS hostname synchronization feature.
  • resolver: List of regions that support the Resolver.
If you do not set this parameter, VolcanoEngine PrivateZone will return the default list of supported regions.

Response parameters

ResponseMetadata object

Name
Type
Description
RequestId
String
The ID that identifies this request.
Action
String
The value of the Action query parameter.
Version
String
The API version.
Service
String
The service type.
Region
String
The region where the service is located.

Result object

Name
Type
Description
Regions
Array of Objects
List of regions.

Example

Request example 

GET https://private-zone.volcengineapi.com/?Action=ListRegions&Version=2022-06-01

Response example 

{
    "ResponseMetadata": {
        "RequestId": "20240722210953A08CAB4A8090C1D41C1D",
        "Action": "ListRegions",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn-beijing"
    },
    "Result": {
        "Regions": [
            {
                "Name": "Asia Pacific (Johor)",
                "Code": "cn-beijing"
            }
        ]
    }
}

Common error codes

Refer to Common Error Codes.

Last updated: 2025.06.26 10:08:23