Obtaining AZs Where CBH Is Available

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	Project ID. To obtain the value, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header. For details, see Obtaining a User Token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
availability_zone	Array of AvailabilityZones objects	AZ information.

**Table 4** AvailabilityZones
Parameter	Type	Description
region_id	String	AZ ID.
id	String	AZ ID.
display_name	String	Displayed AZ name.
status	String	AZ status. Running
type	String	AZ type. Core: core AZ Dedicated: dedicated AZ, which is open only to internal 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	Failed to verify the token.

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

List AvailableZone Info Success

{
  "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"
  } ]
}