Creating a Read Replica

project_id

Yes

String

Definition:

Project ID of a tenant in a region.

To obtain this 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

String

Definition:

Instance ID, which uniquely identifies an instance.

Constraints:

N/A

Range:

The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed.

Default value:

N/A

X-Auth-Token

Yes

String

Definition:

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints:

N/A

Range:

N/A

Default value:

N/A

X-Language

No

String

Definition:

Request language type.

Constraints:

N/A

Range:

• en-us

• zh-cn

Default value:

en-us

priorities

Yes

Array of integers

Definition:

Failover priority of a read replica.

A smaller value indicates a higher priority. This priority determines the order in which read replicas are promoted when recovering from a primary node failure. Read replicas with the same priority have the same probability of being promoted to the new primary node. You can configure a failover priority for up to 9 read replicas, and the default priority for the remaining read replicas is -1, indicating these read replicas cannot be promoted to primary. You can change the failover priority of a read replica.

Constraints:

N/A

Range:

1–16

Default value:

N/A

is_auto_pay

No

String

Definition:

Whether the order will be automatically paid.

Constraints:

This parameter is only available for yearly/monthly instances. It does not affect the payment mode of automatic renewal.

Range:

• true: The order will be automatically paid.

• false: The order will be manually paid.

Default value:

true

instance_id

String

Definition:

Instance ID, which uniquely identifies an instance.

Range:

N/A

node_names

Array of strings

Definition:

Node names.

job_id

String

Definition:

ID of the task for creating a read replica.

This parameter is only returned for pay-per-use read replicas.

Range:

N/A

order_id

String

Definition:

Order ID. This parameter is only returned for yearly/monthly read replicas.

Range:

N/A

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.