Querying CBH Instance Specifications Available for Instance Creation and Changes_Specifications Management_API Description_API Reference

Function

This API is used to query the CBH instance specifications available for instance creation and changes.

Calling Method

For details, see Calling APIs.

URI

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

**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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Definition Action type for querying CBH instance specifications. Constraints N/A Range create: Query the CBH instance specifications available for instance creation. update: Query the CBH instance specifications available for instance changes. Default Value N/A
spec_code	No	String	Definition CBH instance specification code. You can obtain all available specification codes by setting the action parameter to create in this API. Constraints This parameter is mandatory when action is set to update. The value must be a valid CBH specification code. Range String type. The value can contain 1 to 64 characters. Default Value N/A

Request Parameters

**Table 3** 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 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	Definition CBH instance specification name. Range String type. The value can contain 1 to 64 characters.
ecs_system_data_size	Integer	Definition CBH instance system disk size, in GB. Range N/A
cpu	Integer	Definition Number of vCPUs of the CBH instance. Range N/A
ram	Integer	Definition Memory size of the CBH instance, in GB. Range N/A
asset	Integer	Definition The number of assets the CBH instance can manage. Range N/A
connection	Integer	Definition The maximum number of concurrent connections the CBH instance can handle. Range N/A
type	String	Definition CBH instance specification type. Range basic: standard edition enhance: professional edition
data_disk_size	Number	Definition CBH instance data disk size, in TB. Range N/A

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	Token verification failed.

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

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

Querying CBH Instance Specifications Available for Instance Creation and Changes