Querying AZ Information
Function
This API is used to query the AZ ID for creating an instance.
URI
GET /v2/available-zones
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
region_id |
String |
Definition Region ID. Range N/A |
|
available_zones |
Array of ListAvailableZonesElements objects |
Definition Array of AZs. |
|
Parameter |
Type |
Description |
|---|---|---|
|
soldOut |
Boolean |
Definition Whether resources are sold out. Range
|
|
id |
String |
Definition AZ ID. Range N/A |
|
code |
String |
Definition AZ code. Range N/A |
|
name |
String |
Definition AZ name. Range N/A |
|
port |
String |
Definition AZ port. Range N/A |
|
resource_availability |
String |
Definition Whether the AZ has available resources. Range N/A |
|
default_az |
Boolean |
Definition Whether the AZ is the default one. Range
|
|
remain_time |
Long |
Definition Remaining time. Range N/A |
|
ipv6_enable |
Boolean |
Definition Whether IPv6 is supported. Range
|
|
mode |
String |
Definition AZ mode. Range
|
|
scope |
String |
Definition AZ group. Range N/A |
Example Requests
Querying AZ information
GET https://{endpoint}/v2/available-zones
Example Responses
Status code: 200
AZ information queried successfully.
{
"region_id" : "xxx",
"available_zones" : [ {
"soldOut" : false,
"id" : "8c90c2a4e2594c0782faa6b205afeca7",
"code" : "xxx",
"name" : "AZ 1",
"port" : "8002",
"resource_availability" : "true",
"default_az" : false,
"remain_time" : 9223372036854776000,
"ipv6_enable" : false
}, {
"soldOut" : false,
"id" : "d539378ec1314c85b76fefa3f7071458",
"code" : "xxx",
"name" : "AZ 2",
"port" : "8003",
"resource_availability" : "true",
"default_az" : false,
"remain_time" : 9223372036854776000,
"ipv6_enable" : false
}, {
"soldOut" : false,
"id" : "9f1c5806706d4c1fb0eb72f0a9b18c77",
"code" : "xxx",
"name" : "AZ 3",
"port" : "443",
"resource_availability" : "true",
"default_az" : true,
"remain_time" : 9223372036854776000,
"ipv6_enable" : false
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
AZ information queried successfully. |
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.