Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Lightweight Edition)/ Scaling Up Storage Space of an Instance
Updated on 2024-09-11 GMT+08:00

Scaling Up Storage Space of an Instance

Function

This API is used to scale up storage space of an instance. Before calling this API:

URI

PUT /v3/{project_id}/instances/{instance_id}/clickhouse/resize

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

ClickHouse instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

size_in_gb

Yes

Integer

Disk capacity. Value range: 50 GB to 32,000 GB.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

ID of the created task.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Scaling up storage space of a ClickHouse instance

PUT https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/fb632d1d531a4107804f0f082581810fin07/clickhouse/resize

{
  "size_in_gb" : 110
}

Example Response

Status code: 200

Success.

{
  "job_id" : "18ef8ee3-b880-4851-8978-bb6acbd4e695"
}

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.