All Products
Search
Document Center

Hybrid Backup Recovery:DescribeRegions

Last Updated:Nov 14, 2022

Queries available regions.

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
Regionsarray

The list of regions.

object
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

Example

Request example

http(s)://[Endpoint]/?Action=DescribeRegions
&NeedVaultCount=false
&Common request parameters

Normal return example

JSONFormat

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

Error codes

For a list of error codes, visit the API error center.

Change history

Change timeSummary of changesOperate
2022-01-12Add Operation