Wang , Deng Ke
a96a12ecf1
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
13 KiB
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 Using APIs.
- Before calling this API, obtain the required region and endpoint.
Constraints
- The storage space must be a multiple of the number of shards multiplied by 40 GB.
- All nodes must be available.
URI
- URI format
POST https://{Endpoint}/opengauss/v3/{project_id}/instances/{instance_id}/action
- Example
https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
- Parameter description
Table 1 Parameter description Name
Mandatory
Description
project_id
Yes
Specifies the 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
- Parameter description
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
Specifies the storage space, which must always be an integral multiple of (Number of shards x 40 GB). Minimum storage space = Number of shards x 40 GB. Maximum storage space = Number of shards x 16 TB.
- Request example
{ "enlarge_volume": { "size": 400 } }
Response
- Normal response
Table 4 Parameter description Name
Type
Description
job_id
String
Indicates the task ID.
- Example normal response
{ "job_id": "2b414788a6004883a02390e2eb0ea227" } - Abnormal response
For details, see Abnormal Request Results.
Status Codes
For details, see Status Codes.
Error Codes
For details, see Error Codes.