Queries the AZ list.

Function

Queries the AZ list supported by Huawei Cloud Workspace.

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	Yes	String	User token. It can be obtained by calling the IAM API that is 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 supported by Huawei Cloud Workspace.
total_count	Integer	Total number of AZ lists supported by Workspace.

**Table 4** AvailabilityZone
Parameter	Type	Description
availability_zone	String	AZ ID.
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 not specified, all packages are supported.
visible	Boolean	Whether it is visible.
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 description.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 405

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 503

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

GET /v2/92c84e5bce3d48d7ab5714a44901eb08/availability-zones

Example Responses

Status code: 200

Response to the request for querying the AZ list.

{
  "total_count" : 2,
  "availability_zones" : [ {
    "availability_zone" : "cn-north-4a",
    "display_name" : "cn-north-4a",
    "i18n" : {
      "zh_cn" : "AZ 1.",
      "en_us" : "AZ1"
    },
    "sold_out" : {
      "products" : [ "workspace.k.2xlarge.2.linux" ]
    },
    "product_ids" : [ "workspace.k.xlarge.2.linux" ],
    "visible" : "true,",
    "default_availability_zone" : false
  }, {
    "availability_zone" : "cn-north-4b",
    "display_name" : "cn-north-4b",
    "i18n" : {
      "zh_cn" : "AZ 2.",
      "en_us" : "AZ2"
    },
    "sold_out" : {
      "products" : [ "workspace.k.large.2.linux" ]
    },
    "product_ids" : [ "workspace.k.large.2.linux" ],
    "visible" : true,
    "default_availability_zone" : false
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for querying the AZ list.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource found.
405	The request method is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	The service is unavailable.