Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Instance Management/ Scaling up Storage of a Yearly/Monthly DB Instance
Updated on 2023-10-18 GMT+08:00

Scaling up Storage of a Yearly/Monthly DB Instance

Function

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

URI

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

Table 1 URI 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, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

size

Yes

Integer

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

Value:

  • The storage must be at least 50 GB during scale-up.
  • The storage must be at least 40 GB during scale-down.

is_auto_pay

No

String

Whether the order will be automatically paid.

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

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

size

Integer

New storage in GB.

order_id

String

Order ID.

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.