Performing a Primary/Secondary Switchover
Function
This API is used to perform a primary/secondary switchover in a replica set or cluster instance.
Constraints
- This API is available only for replica set and cluster instances.
- This operation cannot be performed on frozen or abnormal instances.
| Name | Mandatory | Type | IN | Description |
|---|---|---|---|---|
| project_id | Yes | string | path | Explanation: Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: N/A Default value: N/A |
| instance_id | Yes | string | path | Explanation: Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one. Constraints: N/A Value range: N/A Default value: N/A |
Request Parameters
| Name | Mandatory | Type | IN | Description |
|---|---|---|---|---|
| X-Auth-Token | Yes | string | header | Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A |
| Name | Type | Mandatory | Description |
|---|---|---|---|
| group_id | String | No | Definition Group ID. Constraints N/A Range
Default Value N/A |
Response Parameters
| Name | Type | Mandatory | Description |
|---|---|---|---|
| job_id | String | Yes | Explanation: The task ID. Value range: N/A |
Example Requests
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switchover
Example Responses
{
"job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
} Status Code
For more information, see Status Code.
Error Code
For more information, see Error Code.
