Updated on 2026-11-05 GMT+08:00

Obtaining the CBH Instance Quota

Function

This API is used to obtain the CBH instance quota.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/cbs/instance/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

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

quota

Integer

Definition

The maximum number of CBH instances you can create.

Range

Integer type. The value ranges from 0 to 64.

quota_used

Integer

Definition

The number of CBH instances you have created.

Range

Integer type. The value ranges from 0 to 64.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Incorrect request parameters.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_description

String

Token verification failed.

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

Not CBH instances found.

Example Requests

None

Example Responses

Status code: 200

{
  "quota" : 5,
  "quota_used" : 1
}

Status Codes

Status Code

Description

200

Search Quota success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.