Querying AZs

Function

Queries AZs where Huawei Cloud Workspace is available.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/availability-zones

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	MIME type of the request body, for example, application/json.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
availability_zones	Array of AvailabilityZone objects	AZs where Huawei Cloud Workspace is available.
total_count	Integer	Total number of AZs where Huawei Cloud Workspace is available.

**Table 4** AvailabilityZone
Parameter	Type	Description
availability_zone	String	AZ code.
display_name	String	AZ name.
i18n	Map<String,String>	AZ internationalization information.
sold_out	SoldOutInfo object	Information about sold-out resources in the current AZ.
product_ids	Array of strings	Product IDs supported by the current AZ. If this parameter is left empty, all packages are supported.
visible	Boolean	Visible or not.
default_availability_zone	Boolean	Whether to set the AZ as a default AZ.

**Table 5** SoldOutInfo
Parameter	Type	Description
products	Array of strings	IDs of sold-out products.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v2/92c84e5bce3d48d7ab5714a44901eb08/availability-zones

Example Responses

Status code: 200

Response to the request for querying AZs.

{
  "availability_zones" : [ {
    "availability_zone" : "string",
    "display_name" : "string",
    "sold_out" : { },
    "product_ids" : [ "string" ],
    "visible" : true,
    "default_availability_zone" : true
  } ],
  "total_count" : 1
}

Status Codes

Status Code	Description
200	Response to the request for querying AZs.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details, see the error code description.
503	Service unavailable.