Help Center/Cloud Bastion Host/API Reference/API Description/Specifications Management/Querying CBH Instance Specifications
Updated on 2025-08-06 GMT+08:00
View PDF

Querying CBH Instance Specifications

Function

This API is used to query CBH instance specifications.

URI

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

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

action

Yes

String

This API is used to query what action is performed for the CBH instance specifications.

  • create: queries the specifications of CBH instances that can be created.

  • update: queries the specifications of a CBH instance that can be modified.

spec_code

No

String

CBH instance specifications. This parameter is mandatory when action is set to update.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

You can obtain it by calling the IAM API. 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

[items]

Array of CbsGetSpecInfo objects

CBH instance specifications.

Table 5 CbsGetSpecInfo

Parameter

Type

Description

resource_spec_code

String

CBH instance specification name.

ecs_system_data_size

Integer

CBH instance system disk size, in GB.

cpu

Integer

The number of CPU cores of a CBH instance.

ram

Integer

The memory (GB) of the CBH instance.

asset

Integer

The number of assets for the CBH instance.

connection

Integer

The maximum number of concurrent connections for a CBH instance.

type

String

CBH instance specification type.

  • basic: Standard edition

  • enhance: Professional edition

data_disk_size

Long

Size of the data disk for the CBH instance, in TB.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Incorrect request parameters.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Failed to verify the token.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_description

String

Permissions required.

Status code: 404

Table 9 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

CBH instance specifications queried

[ {
  "data_disk_size" : 1,
  "ecs_system_data_size" : 10,
  "cpu" : 4,
  "connection" : 10,
  "resource_spec_code" : "cbh.basic.xxx",
  "asset" : 10,
  "type" : "basic",
  "ram" : 8
} ]

Status Codes

Status Code

Description

200

CBH instance specifications queried

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.