Querying CBH Instance Specifications
Function
This API is used to query CBH instance specifications.
URI
GET /v2/{project_id}/cbs/instance/specification
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see "Obtaining a Project ID." |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| action | Yes | String | This API is used to query what action is performed for the CBH instance specifications.
|
| spec_code | No | String | CBH instance specifications. This parameter is mandatory when action is set to update. |
Request 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
| Parameter | Type | Description |
|---|---|---|
| [items] | Array of CbsGetSpecInfo objects | CBH instance specifications. |
| 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.
|
| data_disk_size | Long | Size of the data disk for the CBH instance, in TB. |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_description | String | Incorrect request parameters. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_description | String | Failed to verify the token. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code |
| error_description | String | Permissions required. |
Status code: 404
| 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
