Queries available regions.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeRegions

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

NeedVaultCount Boolean No false

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

Response parameters

Parameter Type Example Description
Code String 200

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

Message String successful

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

RequestId String B3395EC6-7A4A-5282-A9AB-7A442F2CFC90

The ID of the request.

Success Boolean true

Indicates whether the call is successful.

  • true: The call is successful.
  • false: The call fails.
Regions Array of Region

The list of regions.

Region
VaultCount Integer 11

The number of repositories in the region.

LocalName String China (Hangzhou)

The name of the region.

RegionId String cn-hangzhou

The ID of the region.

Examples

Sample requests

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

Sample success responses

XML format

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

<DescribeRegionsResponse>
    <Code>200</Code>
    <Message>successful</Message>
    <RequestId>B3395EC6-7A4A-5282-A9AB-7A442F2CFC90</RequestId>
    <Success>true</Success>
    <Regions>
        <VaultCount>11</VaultCount>
        <LocalName>China (Hangzhou)</LocalName>
        <RegionId>cn-hangzhou</RegionId>
    </Regions>
</DescribeRegionsResponse>

JSON format

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

{
  "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.