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

Scaling Storage Space of an Instance

Function

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

Constraints

This API supports the following types of instances:

  • GeminiDB Cassandra
  • GeminiDB Redis

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

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/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, 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. When you scale down storage space, make sure that new storage space is 25% more than the used space and rounded up. The maximum and minimum storage space depends on the API type and specifications.

is_auto_pay

No

Boolean

Whether the order is automatically paid from your account when you scale up the storage of a yearly/monthly instance. 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: 200

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
    PUT https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/volume
  • Changing storage space of an instance to 550 GB
    {
  "size" : 550
}

Example Responses

Status code: 200

Success

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