Obtaining the AZ List
Function
This API is used to obtain the AZ list.
Calling Method
For details, see Calling APIs.
URI
GET /api/v2/availabilityZones
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
locale |
No |
String |
Definition: AZ name display setting by region Range:
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Details: The request body type or format Constraints: The GET method is not verified. Options:
Default value: N/A |
X-Auth-Token |
Yes |
String |
Details: Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token. Constraints: None Options: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
[items] |
Array of GetAvailableZoneResponseBody objects |
Definition AZ list information Constraints N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: AZ ID. Options: N/A |
name |
String |
Definition: AZ name. Options: N/A |
displayName |
String |
Definition: AZ name displayed in the region where the AZ is located. Options: N/A |
azGroupIds |
Array of strings |
Definition: Groups that an AZ belongs to. An AZ can belong to multiple AZ groups. Options: N/A |
PublicBorderGroup |
String |
Definition: Group that an EIP belongs to. In the CloudPond edge scenario, the value is the AZ ID. In the central region, the value is center. Options: N/A |
category |
String |
Definition: AZ type. Options:
|
alias |
String |
Definition: AZ alias. Options: N/A |
Example Requests
None
Example Responses
Status code: 200
The AZ list has been obtained.
[ { "id" : "cn-north-4a", "name" : "AZ1", "displayName" : "AZ1", "azGroupIds" : [ "cn-north-4-all" ], "publicBorderGroup" : "center", "category" : "Default", "alias" : "AZ1" } ]
Status Codes
Status Code |
Description |
---|---|
200 |
The AZ list has been obtained. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot