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

Adding CNs

Function

This API is used to add CNs. 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 CN growth increment ranges from 1 to 9.
  • The maximum number of CNs is 256.
  • If you choose the single-AZ deployment during instance creation, add CNs in the same AZ.
  • The number of CNs of a DB instance cannot exceed twice the number of shards.

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

expand_cluster

Yes

Object

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

Parameter

Mandatory

Type

Description

coordinators

Yes

Array

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

Parameter

Mandatory

Type

Description

az_code

Yes

String

AZs to which CNs are to be added.

Response Parameters

Table 5 Response parameters

Parameter

Type

Description

job_id

String

Task ID.

Example Request

  • Adding a CN 
    https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
{
	"expand_cluster": {
                "coordinators": [
                        {
                               "az_code":"az1xahz"
                        }
                ],
               "isAutoPay":0
	}
}
  • Adding CNs 
    https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action
{
	"expand_cluster": {
                "coordinators": [
                        {
                               "az_code":"az1xahz"
                        },
                        {
                               "az_code":"az2xahz"
                        },
                        {
                               "az_code":"az3xahz"
                        }
                ]
	}
}

Example Response

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

Status Code

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management