Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to switch the primary and secondary AZs of a cluster.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: SwitchClusterZone. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| ClusterId | Yes | String | Cluster Id |
| OldZone | Yes | String | Current availability zone |
| NewZone | Yes | String | Availability zone to switch to |
| IsInMaintainPeriod | No | String | Execute during maintenance period - yes, immediately execute - no |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | Integer | Task ID. |
| FlowId | Integer | Async FlowId |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SwitchClusterZone
<Common request parameters>
{
"ClusterId": "cynosdbmysql-8f0sh2nj",
"OldZone": "ap-guangzhou-3",
"NewZone": "ap-guangzhou-5",
"IsInMaintainPeriod": "no"
}
{
"Response": {
"FlowId": 88529647,
"TaskId": 183430,
"RequestId": "61e043aa-4b66-4021-a3cb-7b31df93def7"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the problem persists, contact customer service. |
| InvalidParameterValue.InvalidParameterValueError | Invalid parameter value. |
| OperationDenied.ClusterStatusDeniedError | For the cluster in this status, the operation is not allowed. |
| ResourceNotFound.ClusterNotFoundError | The cluster does not exist. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback