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

Obtaining the ECS Resource Quota Required for Creating a CBH Instance

Function

Check whether the ECS specifications can be used for the CBH instance in the selected region.

URI

GET /v2/{project_id}/cbs/instance/ecs-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".
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

availability_zone

Yes

String

AZ name.

For details, see "Obtaining AZs Where CBH Is Available."

resource_spec_code

Yes

String

ID of the specification of the CBH instance to be created, for example:

  • cbh.basic.10: Standard edition - Asset 10

  • cbh.enhance.10: Professional edition - Asset 10

For details, see "Querying CBH Instance Specifications."

Request Parameters

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

Parameter

Type

Description

status_v6

String

Status of CBH specifications that support IPv6.

  • sellout: sold out.

  • normal: in normal commercial use.

status

String

Status of CBH specifications.

  • sellout: sold out.

  • normal: 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

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

Get Ecs Quota Success

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

Parent topic: Quota Management