Obtaining AZs Where CBH Is Available_Querying AZs_API Description_API Reference

Function

This API is used to query AZs where CBH is available.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/cbs/available-zone

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which uniquely identifies a project. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token 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. For details, see Obtaining a User Token. Constraints N/A Range String type. The value can contain 1 to 28,000 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
availability_zone	Array of AvailabilityZones objects	Definition List of AZ information. A maximum of 36 AZ objects are supported.

**Table 4** AvailabilityZones
Parameter	Type	Description
region_id	String	Definition ID of the region that the AZ belongs to. Range String type. The value can contain 1 to 64 characters.
id	String	Definition AZ ID. Range String type. The value can contain 1 to 64 characters.
display_name	String	Definition Displayed AZ name. Range String type. The value can contain 1 to 64 characters.
status	String	Definition AZ status. Range Running: running
type	String	Definition AZ type. Range Core: core AZ. Dedicated: dedicated AZ, open only to whitelisted users.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Incorrect request parameters.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Token verification failed.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Permissions required.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_description	String	Not CBH instances found.

Example Requests

None

Example Responses

Status code: 200

{
  "availability_zone" : [ {
    "region_id" : "cn-north-4",
    "id" : "cn-north-4a",
    "type" : "Core",
    "display_name" : "AZ 1",
    "status" : "Running"
  }, {
    "region_id" : "cn-north-4",
    "id" : "cn-north-4b",
    "type" : "Core",
    "display_name" : "AZ 2",
    "status" : "Running"
  }, {
    "region_id" : "cn-north-4",
    "id" : "cn-north-4c",
    "type" : "Core",
    "display_name" : "AZ 3",
    "status" : "Running"
  } ]
}

Status Codes

Status Code	Description
200	List AvailableZone Info Success
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found

Error Codes

See Error Codes.

Obtaining AZs Where CBH Is Available