Querying AZ Information
Function
This API is used to query the AZ ID for creating an instance.
Calling Method
For details, see Calling APIs.
URI
GET /v2/available-zones
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
region_id |
String |
Definition Region ID. Constraints N/A Range N/A Default Value N/A |
|
available_zones |
Array of ListAvailableZonesElements objects |
Definition Array of AZs. Constraints N/A Range N/A Default Value N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
soldOut |
Boolean |
Definition Whether resources are sold out. Constraints N/A Range
Default Value N/A |
|
id |
String |
Definition AZ ID. Constraints N/A Range N/A Default Value N/A |
|
code |
String |
Definition AZ code. Constraints N/A Range N/A Default Value N/A |
|
name |
String |
Definition AZ name. Constraints N/A Range N/A Default Value N/A |
|
port |
String |
Definition AZ port. Constraints N/A Range N/A Default Value N/A |
|
resource_availability |
String |
Definition Whether the AZ has available resources. Constraints N/A Range N/A Default Value N/A |
|
default_az |
Boolean |
Definition Whether the AZ is the default one. Constraints N/A Range
Default Value N/A |
|
remain_time |
Long |
Definition Remaining time. Constraints N/A Range N/A Default Value N/A |
|
ipv6_enable |
Boolean |
Definition Whether IPv6 is supported. Constraints N/A Range
Default Value N/A |
|
mode |
String |
Definition AZ mode. Range
|
|
scope |
String |
Definition AZ group. Constraints N/A Range N/A Default Value 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
} ]
}
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.rocketmq.v2.region.RocketMQRegion; import com.huaweicloud.sdk.rocketmq.v2.*; import com.huaweicloud.sdk.rocketmq.v2.model.*; public class ListAvailableZonesSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); RocketMQClient client = RocketMQClient.newBuilder() .withCredential(auth) .withRegion(RocketMQRegion.valueOf("<YOUR REGION>")) .build(); ListAvailableZonesRequest request = new ListAvailableZonesRequest(); try { ListAvailableZonesResponse response = client.listAvailableZones(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkrocketmq.v2.region.rocketmq_region import RocketMQRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkrocketmq.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = RocketMQClient.new_builder() \ .with_credentials(credentials) \ .with_region(RocketMQRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAvailableZonesRequest() response = client.list_available_zones(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" rocketmq "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/rocketmq/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := rocketmq.NewRocketMQClient( rocketmq.RocketMQClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAvailableZonesRequest{} response, err := client.ListAvailableZones(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot