Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ DB Instance Management/ Scaling Up Storage Space of a DB Instance
Updated on 2026-02-04 GMT+08:00
View PDF
Share

Scaling Up Storage Space of a DB Instance

Function

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

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 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

Dependencies

rds:instance:extendSpace

permission_management

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

Constraints

  • The sizes of the primary and standby DB instances are the same. When you scale the primary DB instance, its standby DB instance is also scaled.
  • The storage space can be scaled up only when your instance status is Available or Storage full.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/action

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    Constraints

    The value cannot be empty.

    Range

    To obtain the value, see Obtaining a Project ID.

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    The value cannot be empty.

    Range

    You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances.

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

enlarge_volume

Yes

Object

Definition

Specifies the target storage space after scaling up.

For details, see Table 3.

Constraints

N/A
Table 3 enlarge_volume field data structure description

Parameter

Mandatory

Type

Description

size

Yes

Integer

Definition

Target storage space after scale-up.

Constraints

N/A

Range

40–4000, in GB. The minimum increment for each scaling is 10 GB.

If you want to create an RDS for PostgreSQL DB instance that supports storage from 40 GB to 15,000 GB, contact customer service to apply for the required permissions.

Default Value

N/A

is_auto_pay

No

Boolean

Definition

Whether the order will be automatically paid when the storage space of yearly/monthly instances is scaled up.

Constraints

N/A

Range

  • true: indicates the order will be automatically paid.
  • false: indicates the order will be manually paid. The default value is false.

Default Value

false

Example Request

Scale up storage space of a DB instance to 400 GB. 
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action


{
	"enlarge_volume": {
		"size": 400,
                "is_auto_pay": true
	}
}

Response

  • Pay-per-use
    • Normal response
      Table 4 Parameters

      Parameter

      Type

      Description

      job_id

      String

      Definition

      Task ID.

      Range

      N/A
    • Example normal response 
      {
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}
    • Abnormal response

      For details, see Abnormal Request Results.

  • Yearly/Monthly
    • Normal response
      Table 5 Parameters

      Parameter

      Type

      Description

      order_id

      String

      Definition

      Order ID.

      Range

      N/A
    • Example normal response 
      {
	"order_id": "CS2009151216NO2U2"
}
    • Abnormal response

      For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management