Help Center/ Cloud Bastion Host/ API Reference/ API Description/ Querying CBH Details/ Obtaining the ECS Quota
Updated on 2023-05-16 GMT+08:00
View PDF

Obtaining the ECS Quota

Function

This API is used to obtain the details about the specifications and AZ of the selected ECS so as to determine whether the ECS can be used.

URI

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

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

availability_zone

Yes

String

AZ of the CBH instance being created. You can view Regions and Endpoints at https://developer.huaweicloud.com/intl/en-us/endpoint.

resource_spec_code

Yes

String

CBH instance specification ID.

  • cbh.basic.50: Standard edition/50 assets.

  • cbh.enhance.50: Professional edition/50 assets. For more details, see "CBH Instance Editions" at https://support.huaweicloud.com/intl/en-us/cbh_faq/cbh_03_0025.html.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status_v6

String

Status of ECSs that support IPv6 addresses.

  • sellout: The type of ECS is sold out.

  • normal: The type of ECS is in commercial use.

  • abandon The type of ECS is discontinued (not displayed on the console).

status

String

Status of ECSs.

  • sellout: The type of ECS is sold out.

  • normal: The type of ECS is in commercial use.

  • abandon The type of ECS is discontinued (not displayed on the console).

eip_quota

Integer

ECS quota. By default, null is returned.

quota

Integer

Remaining CBH quota. By default, null is returned.

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

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: Querying CBH Details