Help Center/ GaussDB/ API Reference/ Historical APIs/ DB Instance Management/ Adding Shards
Updated on 2024-08-20 GMT+08:00
View PDF
Share

Adding Shards

Function

This API is used to add shards. 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.

Intermittent disconnection occurs when shards are being added. Exercise caution when performing this operation.

Constraints

  • The shard growth increment ranges from 1 to 9.
  • The maximum number of shards is 256.

URI

POST https://{Endpoint}/gaussdb/v3/{project_id}/instances/{instance_id}/action

Table 1 Parameter description

Name

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

Name

Mandatory

Type

Description

expand_cluster

Yes

Object

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

Name

Mandatory

Type

Description

shard

Yes

Object

For details, see Table 4.
Table 4 count field data structure description

Name

Mandatory

Type

Description

count

Yes

Integer

Number of shards to be added.

Response Parameters

Table 5 Response parameters

Name

Type

Description

job_id

String

Task ID.

Example Request

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
{
	"expand_cluster": {
                "shard":{
                       "count":1
                }
                
	}
}

Example Response

  • Example response 
    {
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management