Querying AZ Details

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/detail

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
availability_zone_id	Yes	String	AZ ID.

Request Parameters

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
id	String	Corresponds to the zoneCode field in the region data of CMDB.
region_id	String	Corresponds to the regionCode field in the region data of CMDB.
type	String	AZ type. Options: Edge: edge cloud Workspace: Huawei Cloud
display_name	String	English name.
status	String	Status.
sold_out	SoldOutInfo object	Information about sold-out resources in the current AZ.
product_ids	Array of strings	Product ID set.
mode	String	Billing mode, which can be dedicated or shared.
alias	String	AZ alias, which can contain a maximum of 128 characters, including digits, letters, underscores (_), and hyphens (-).
public_border_group	String	Group to which the EIP belongs.
category	Integer	Category ID: 0: default 21: HomeZone 41: IES

**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: 500

**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.

Example Requests

GET /v2/92c84e5bce3d48d7ab5714a44901eb08/availability-zones/detail?availability_zone_id=br-iaas-odin1raa

Example Responses

Status code: 200

Response to the request for querying AZs.

{
  "id" : "string",
  "region_id" : "string",
  "type" : "string",
  "display_name" : "string",
  "status" : "string",
  "sold_out" : {
    "products" : [ "string" ]
  },
  "product_ids" : [ "string" ],
  "mode" : "string",
  "alias" : "string",
  "public_border_group" : "string",
  "category" : 0
}

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.
500	An internal service error occurred. For details, see the error code description.