Help Center> GaussDB> API Reference> API> Managing DB Instances> Scaling Up Storage Space of a Yearly/Monthly DB Instance
View PDF

Scaling Up Storage Space of a Yearly/Monthly DB Instance

Function

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

URI

  • URI format

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

  • Example

    POST https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/volume/extend

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    To obtain this value, see Obtaining a Project ID.

    instance_id

    Yes

    DB instance ID, which is compliant with the UUID format.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

size

Yes

Integer

Storage space after expansion. The value ranges from 40 GB to 128,000 GB. The minimum increment for each scaling is 10 GB.

is_auto_pay

No

String

Whether the order will be automatically paid.

  • true: indicates the order will be automatically paid. The default value is true.
  • false: indicates the order will be manually paid.
  • Request example 
    {
"size":50,
"is_auto_pay":"true"
}

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    size

    Integer

    Storage space after expansion.

    order_id

    String

    Order ID.
  • Example normal response 
    {
"size":50,
"order_id": "CS2006231950I8NQA"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Managing DB Instances