All Products
Search
Document Center

Cloud Backup:DescribeRegions

Last Updated:Mar 03, 2024

Queries available regions.

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
NeedVaultCountbooleanNo

Specifies whether to return detailed information. Default value: false.

false

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
RequestIdstring

The ID of the request.

B3395EC6-7A4A-5282-A9AB-7A442F2CFC90
Successboolean

Indicates whether the call is successful.

  • true: The call is successful.
  • false: The call fails.
true
Regionsobject []

The list of regions.

VaultCountinteger

The number of repositories in the region.

11
LocalNamestring

The name of the region.

China (Hangzhou)
RegionIdstring

The ID of the region.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "B3395EC6-7A4A-5282-A9AB-7A442F2CFC90",
  "Success": true,
  "Regions": {
    "Region": [
      {
        "VaultCount": 11,
        "LocalName": "China (Hangzhou)",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-02-26The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    delete Input Parameters: NeedVaultCount
Output ParametersThe response structure of the API has changed.
2022-01-12Add Operationsee changesets