Get the list of regions and availability zones - GetRegion
Overview
Obtain user's permissions and other information in various data centers
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetRegion . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Regions | array[RegionInfo] | Information of Each Data Center | No |
Data Model
RegionInfo
Field Name | Type | Description Information | Required |
---|---|---|---|
RegionId | int | Data Center ID | Yes |
RegionName | string | Data Center Name | Yes |
IsDefault | boolean | Is the user's current default data center | Yes |
BitMaps | string | The permission bit of the user in this data center | Yes |
Region | string | Region name, such as cn-bj | Yes |
Zone | string | Availability zone name, such as cn-bj-01 | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=GetRegion
Response Example
{
"Action": "GetRegionResponse",
"RetCode": 0
}