Help Center/ GaussDB/ API Reference/ Historical APIs/ DB Instance Management/ Scaling up Storage Space of a DB Instance
Updated on 2024-08-20 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 this API:

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Adding CNs and DN shards and Scaling up Storage) before then.

Constraints

  • The storage space must be a multiple of the number of shards multiplied by 4 GB.
  • All nodes must be available.

URI

POST https://{Endpoint}/gaussdb/v3/{project_id}/instances/{instance_id}/action
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Explanation:

Project ID of a tenant in a region.

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

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

instance_id

Yes

Instance ID.

Request Parameters

Table 2 Request parameters

Parameter

Mandatory

Type

Description

enlarge_volume

Yes

Object

Target storage space after scaling up.

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

Parameter

Mandatory

Type

Description

size

Yes

Integer

Storage space, which must always be an integral multiple of (Number of shards x 4 GB). Value range: (Number of shards x 40 GB) to (Number of shards x 16 TB).

Response Parameters

Table 4 Response parameters

Parameter

Type

Description

job_id

String

Task ID.

Example Request

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
{
	"enlarge_volume": {
		"size": 400
	}
}

Example Response

{
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management