Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Quota Management/ Obtaining the ECS Resource Quota Required for Creating a CBH Instance
Updated on 2026-11-05 GMT+08:00

Obtaining the ECS Resource Quota Required for Creating a CBH Instance

Function

This API is used to check whether there are available ECS specifications for creating the bastion host instance in the selected AZ.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/cbs/instance/ecs-quota

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

availability_zone

Yes

String

Definition

AZ name. For details, see Obtaining AZs Where the Service Is Available.

Constraints

The AZ must exist and be in the Running state.

Range

String type. The value can contain 1 to 64 characters.

Default Value

N/A

resource_spec_code

Yes

String

Definition

ID of the specification of the CBH instance to be created. For details, see Querying CBH Instance Specifications.

Constraints

The value must be a valid CBH specification code.

Range

The value is determined by the instance edition, instance type, and number of assets. For example, cbh.basic.10 indicates 10-asset single-node standard edition instances, and cbh.enhance.ha.10 indicates 10-asset primary/standby professional edition instances.

Default Value

N/A

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

status_v6

String

Definition

Status of the CBH specifications that support IPv6.

Range

  • sellout: Resources have been sold out.

  • normal: Resources are in normal commercial use.

status

String

Definition

Status of CBH specifications.

Range

  • sellout: Resources have been sold out.

  • normal: Resources are in normal commercial use.

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

{
  "status_v6" : "sellout",
  "status" : "normal"
}

Status Codes

Status Code

Description

200

Get Ecs Quota Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.