Query Sale Region

Last updated: 2017-12-06 16:22:49

1. API Description

This API (DescribeRedisZones) is used to query supported availability zones.
Domain name for API request: redis.api.qcloud.com

This API can be used to create the list of availability zones where the Redis can be created. An availability zone where the CRS instance is not available for the user will not be included in the returned list. You can apply for the purchase of the whitelist of a region by submitting a Ticket.

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters are also needed when the API is called. For more information, please see Common Request Parameters page. The Action field for this API is DescribeRedisZones.

Parameter Name Required Type Description
None None None None

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed. For more information, please see Common Error Codes on the Error Codes page.
message String Error message description. A null value indicates a success
codeDesc String Description of error code at business side. For a successful operation, "Success" will be returned. In case of an error, a message describing the reason for the error will be returned.
data Array
data.zones Array List of all the availability zones
data.zones.100002 String The availability zone name corresponding to the availability zone ID. For example, for the availability zone ID 10002, the availability zone name is Guangzhou Zone 2

4. Error Codes

The following error codes include the business logic error codes for this API.

Error Code Error Message Error Description
11052 UserNotInWhiteList The user is not in the whitelist

5. Example

Input


https://redis.api.qcloud.com/v2/index.php?Action=DescribeRedisZones
&<Common Request Parameters>

Output

{
    "code":"0",
    "message":"",
    "codeDesc": "Success",
    "data":{
        "zones":[
            {
                "100002":"Guangzhou Zone 2"
            },
            {
                "200001":"Shanghai Zone 1"
            },
            {
                "300001":"Hong Kong Zone 1"
            },
            {
                "400001":"North America Zone 1"
            }
        ]
    },
}