Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Quota Management/ Obtaining the CBH Instance Quota
Updated on 2024-11-12 GMT+08:00
View PDF
Share

Obtaining the CBH Instance Quota

Function

This API is used to obtain the CBH instance quota.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

For details about how to obtain the project ID, see "Obtaining a Project ID".

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained 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 the Token of an IAM User."

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

quota

Integer

The maximum number of CBH instances that can be created.

quota_used

Integer

The number of created CBH instances.

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

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

Not CBH instances found.

Example Requests

None

Example Responses

Status code: 200

Search Quota success

{
  "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.

Parent topic: Quota Management