Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ DB Instance Management/ Scaling Up Storage Space of a DB Instance
Updated on 2024-06-07 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.

  • Before calling an API, you need to understand the API in Authentication.

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

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

enlarge_volume

Yes

Object

Specifies the target storage space after scaling up.

For details, see Table 3.
Table 3 enlarge_volume field data structure description

Name

Mandatory

Type

Description

size

Yes

Integer

A DB instance can be scaled up only by a multiple of 10 GB. Value range: 40 GB to 4,000 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.

is_auto_pay

No

Boolean

Specifies whether the order will be automatically paid when the storage space of yearly/monthly DB instances is scaled.

  • true: indicates the order will be automatically paid.
  • false: indicates the order will be manually paid. The default value is 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 Parameter description

      Name

      Type

      Description

      job_id

      String

      Task ID.
    • Example normal response 
      {
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}
    • Abnormal response

      For details, see Abnormal Request Results.

  • Yearly/Monthly
    • Normal response
      Table 5 Parameter description

      Name

      Type

      Description

      order_id

      String

      Order ID.
    • 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