Help Center> GeminiDB> API Reference> APIs v3 (Recommended)> Instances> Scaling Up Storage Space of an Instance
Updated on 2023-11-21 GMT+08:00
View PDF

Scaling Up Storage Space of an Instance

Function

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

Constraints

This API supports the following types of instances:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

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

Only GeminiDB Cassandra and GeminiDB Influx allow you to restore data of a specified time point from a specified cluster instance to a new cluster instance.

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/extend-volume

Table 1 Path 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

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.

is_auto_pay

No

String

Whether the order will be automatically paid after a yearly/monthly instance is created. This parameter does not affect the payment mode of automatic renewal.

  • true: indicates that the order is automatically paid from the account.
  • false: indicates that the order is manually paid from the account. The default value is false.

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID. This parameter is returned only for pay-per-use instances.

order_id

String

Order ID. This parameter is returned only when a yearly/monthly instance is created.

Example Requests

  • URI example
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/extend-volume
  • Scaling up storage space of an instance to 550 GB
    {
  "size" : 550
}

Example Responses

Status code: 202

Accepted

Example response for a pay-per-use instance:

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

Example response for a yearly/monthly instance:

{
  "order_id" : "CS20070721568OVO9"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances