Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Scaling up Storage of a Yearly/Monthly DB Instance
Updated on 2025-10-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Scaling up Storage of a Yearly/Monthly DB Instance

Function

This API is used to scale up the storage of a yearly/monthly DB instance. Before calling this API:

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:instance:modifyStorageSize

    Permission_management

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:instance:modify
    • gaussdb:instance:modifyStorageSize

    -

URI

POST /v3/{project_id}/instances/{instance_id}/volume/extend

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

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.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

size

Yes

Integer

Definition

Storage space after scale-up.

Constraints

The initial minimum storage of a yearly/monthly instance is 10 GB. The new storage must be a multiple of 10 and greater than the used storage. The maximum storage is 128,000 GB.

Range

The storage must be at least 20 GB during scale-up.

The storage must be at least 10 GB during scale-down.

Default Value

N/A

is_auto_pay

No

String

Definition

Whether the order will be automatically paid.

Constraints

N/A

Range

  • true: The order will be automatically paid.

  • false: The order will be manually paid.

Default Value

true

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

size

Integer

Definition

Storage space after scale-up.

Range

N/A

order_id

String

Definition

Order ID.

Range

N/A

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

Scaling up the storage of a yearly/monthly DB instance to 50 GB

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/volume/extend
{
  "size" : 50
}

Example Response

Status code: 201

Success.

{
  "size" : 50,
  "order_id" : "CS2001221129LVGUU"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management