Files
doc-exports/docs/geminidb/api-ref/nosql_05_0116.html
wangdengke2 59805c5073 GeminiDB_API
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2026-03-12 09:56:41 +00:00

10 KiB

Scaling Storage Space of an Instance

Function

This API is used to scale storage space of an instance.

Constraints

This API supports the following instances:

  • GeminiDB Cassandra

This API supports both yearly/monthly and pay-per-use instances.

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/volume

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

Instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. application/json is recommended.

X-Auth-Token

Yes

String

User token

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

size

Yes

Integer

Requested storage space, in GB. The value must be an integer. When you want to scale up storage space, the requested storage value must be greater than the current storage. To scale down storage, ensure the new storage space is at least 1.25 times more than the used space and rounded up. The maximum and minimum storage space depends on the API type and specifications.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

Example Requests

  • URI example
    PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/volume
  • Changing storage space of an instance to 550 GB
    {
      "size" : 550
    }

Example Responses

Status code: 202

Success

{
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}

Status Codes

See Status Codes.

Error Codes

See Error Codes.