Files
doc-exports/docs/geminidb/api-ref/nosql_05_0050.html
wangdengke2 8d0926f0e5 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>
2025-09-04 07:22:35 +00:00

10 KiB

Scaling Up Storage Space of an Instance

Function

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

Constraints

This API can be used for GeminiDB Cassandra instances.

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/extend-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 parameter

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. It must be an integer greater than the current storage space.

The maximum 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 Request

  • URI example
    POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/extend-volume
  • Scaling up storage space of an instance to 550 GB
    {
      "size" : 550
    }

Example Response

Status code: 202

Accepted

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

Status Codes

See Status Codes.

Error Codes

See Error Codes.