Querying AZs (by Site)

Function

Queries supported AZs by site. Queries supported AZs.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/availability-zone/summary

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Unique ID of a project

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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
azs	Map<String,Array<AvailabilityZoneInfo>>	AZs where Workspace Application Streaming is available. These AZs are classified by site.
default_type	String	Default site type. CENTER IES
support_type	Array of strings	Site types supported by Workspace Application Streaming. CENTER IES

**Table 4** AvailabilityZoneInfo
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 not specified, all packages are supported.
visible	Boolean	Whether it is visible.
default_availability_zone	Boolean	Whether to set an AZ as the 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, which is returned upon failure.
error_msg	String	Error message.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 405

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 503

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Example Requests

GET /v1/29dfe82ada564ac2b927e1ff036d9a9b/availability-zone/summary

Example Responses

Status code: 200

Response to a successful request.

{
  "azs" : {
    "CENTER" : [ {
      "availability_zone" : "cn-north-7a",
      "display_name" : "cn-north-7a",
      "i18n" : {
        "en_us" : "AZ1",
        "zh_cn" : "AZ 1"
      },
      "sold_out" : {
        "products" : [ ]
      },
      "product_ids" : [ ],
      "visible" : true,
      "default_availability_zone" : false
    }, {
      "availability_zone" : "cn-north-7b",
      "display_name" : "cn-north-7b",
      "i18n" : {
        "en_us" : "AZ2",
        "zh_cn" : "AZ 2"
      },
      "sold_out" : {
        "products" : [ ]
      },
      "product_ids" : [ ],
      "visible" : true,
      "default_availability_zone" : false
    } ],
    "IES" : [ {
      "availability_zone" : "cn-north-7c",
      "display_name" : "cn-north-7c",
      "i18n" : {
        "en_us" : "AZ3",
        "zh_cn" : "AZ 3"
      },
      "sold_out" : {
        "products" : [ ]
      },
      "product_ids" : [ ],
      "visible" : true,
      "default_availability_zone" : false
    } ]
  },
  "default_type" : "CENTER",
  "support_type" : [ "CENTER" ]
}

Status Codes

Status Code	Description
200	Response to a successful request.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	Permissions required.
404	Resources not 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.

Error Codes

See Error Codes.

Parent topic: AZ Management

Previous topic: Querying AZs

Next topic: Disk Management

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot