Obtaining the AZ Where CBH Is Deployed

Updated on 2023-05-16 GMT+08:00

View PDF

Function

This API is used to obtain AZ where a CBH instance is deployed.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. You can obtain the project ID by referring to https://support.huaweicloud.com/intl/en-us/api-cbh/cbh_02_0020.html.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
availability_zone	AvailabilityZones object	AZ where a CBH instance is deployed.

**Table 3** AvailabilityZones
Parameter	Type	Description
id	String	ID of the AZ where a CBH instance is deployed.
display_name	String	Display name of the AZ where a CBH instance is deployed.
region_id	String	ID of the AZ where a CBH instance is deployed.
status	String	State of the AZ where a CBH instance is deployed.
type	String	Type of the AZ where a CBH instance is deployed.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_description	String	Incorrect request parameter.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_description	String	Failed to verify the token.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_description	String	Permissions required.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_description	String	CBH instances not found.

Example Requests

None

Example Responses

Status code: 200

Cbh List Information

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