Querying AZ Summary

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

**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
support_type	Array of strings	Supported type.
default_type	String	Default type.
azs	Map<String,Array<AzInfo>>	AZ.

**Table 4** AzInfo
Parameter	Type	Description
availability_zone	String	AZ name.
i18n	I18n object	Internationalization.
default_availability_zone	Boolean	Whether the AZ is the default one.

**Table 5** I18n
Parameter	Type	Description
zh_cn	String	AZ name in Chinese.
en_us	String	AZ name in English.

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

Example Responses

Status code: 200

Response to the request for querying AZs.

{
  "support_type" : [ "string" ],
  "default_type" : "string",
  "azs" : {
    "CENTER" : [ {
      "availability_zone" : "string",
      "i18n" : {
        "zh_cn" : "string",
        "en_us" : "string"
      },
      "default_availability_zone" : true
    } ],
    "IES" : [ {
      "availability_zone" : "string",
      "i18n" : {
        "zh_cn" : "string",
        "en_us" : "string"
      },
      "default_availability_zone" : true
    } ]
  }
}

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.