doc-exports/docs/opengauss/api-ref/opengauss_api_1016.html

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:

• Learn how to authenticate this API.
• Understand the API in Using APIs.
• 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	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.
  instance_id	Yes	DB instance ID.

Request

• Parameter description

  Table 2 Parameter description

  Name	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

  Name	Mandatory	Type	Description
  size	Yes	Integer	Storage space, which must always be a multiple of (Number of shards x 40 GB). Value range: (Number of shards x 40 GB) to (Number of shards x 16 TB).

• Example request

  {
  	"enlarge_volume": {
  		"size": 400
  	}
  }

Response

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

Status Code

• Normal

  202

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management