Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Changing a 1 Primary + 1 Standby + 1 Log Instance to a 1 Primary + 2 Standby Instance
Updated on 2025-10-20 GMT+08:00
View PDF
Share

Changing a 1 Primary + 1 Standby + 1 Log Instance to a 1 Primary + 2 Standby Instance

Function

This API is used to change the deployment model of a distributed instance from 1 primary + 1 standby + 1 log to primary + 2 standby. Before calling this API:

Debugging

You can debug this API in API Explorer.

Constraints

Currently, this API is only available for distributed instances in the independent deployment and it is used to change a 1 primary + 1 standby + 1 log instance to a 1 primary + 2 standby instance.

URI

POST /v3/{project_id}/instances/{instance_id}/switch-replica

Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

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

Default Value

N/A

instance_id

Yes

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

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

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Language.

Constraints

N/A

Range

  • zh-cn
  • en-us

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

is_auto_pay

No

Boolean

Definition

Whether the order will be automatically paid after yearly/monthly instances are created. This parameter does not affect the payment mode of automatic renewal.

Constraints

N/A

Range

  • true: The order is automatically paid from the account.
  • false: The order is manually paid from the account.

Default Value

false

Response Parameters

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

Job ID.

Range

N/A

order_id

String

Definition

Order ID.

Range

N/A

Example Request

Changing the deployment model of a distributed instance from 1 primary + 1 standby + 1 log to primary + 2 standby

 
POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/5362449138da4e408dbae5152ca26640in14/switch-replica 

{ 
  "is_auto_pay" : true 
}

Example Response

{ 
  "job_id" : "0da624f7-0eec-4e2b-bfef-0685bb5591f6" 
}

Status Codes

Error Codes

For details, see Error Codes.

Parent topic: Instance Management