Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ HTAP (Lightweight Edition)/ Changing Instance Specifications
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Changing Instance Specifications

Function

This API is used to change instance specifications. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/clickhouse/resize-flavor

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 parameters

Parameter

Mandatory

Type

Description

flavor_ref

Yes

String

Specification ID. To obtain this value, see Querying Specifications of an HTAP Instance.

Only the specification ID of the corresponding instance can be used.

delay

Yes

Boolean

Whether to delay the change. The default value is false.

instance_id

No

String

Instance ID, which is compliant with the UUID format.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

result

String

Request result.

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

Changing the specifications of a ClickHouse instance

POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/fb632d1d531a4107804f0f082581810fin07/clickhouse/resize-flavor

{
  "flavor_ref" : "6ebc6add-7462-3c27-b92b-3d79ae37a309",
  "delay" : false,
  "instance_id" : "59c6b263cd884178b7395e1ee8d93fbdin16"
}

Example Response

Status code: 200

Success.

{
  "result" : "3077fd46-2924-4513-ae07-82bac7886a9c"
}

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.