Release Notes
Announcements
Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to set a read-only instance in a replication group as a master instance.
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: ChangeMasterInstance. |
| Version | Yes | String | Common Params. The value used for this API: 2018-04-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| GroupId | Yes | String | Replication group ID, such as crs-rpl-m3zt****. It is the unique identifier automatically assigned by the system when creating a replication group. Log in to the TencentDB for Redis console, and get it in the global replication list. |
| InstanceId | Yes | String | ID of the read-only instance to be promoted to the master instance, such as crs-xjhsdj****. Log in to the the TencentDB for Redis console, and copy it in the instance list. |
| ForceSwitch | No | Boolean | Whether to promote the read-only instance to the master instance forcibly. Valid values: - true: Yes- false: No |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | Integer | Async task ID |
| 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. |
This example shows you how to set a read-only instance in a replication group as a master instance.
POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChangeMasterInstance
<Common request parameters>
{
"InstanceId": "crs-sa5****",
"GroupId": "crs-rpl-sa5****",
"ForceSwitch": false
}{
"Response": {
"TaskId": 327,
"RequestId": "e546784b-709c-401d-aba6-73037eb4e522"
}
}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.SystemError | Internal system error, which is irrelevant to the business. |
| FailedOperation.UnSupportError | The instance does not support this API. |
| InternalError.DbOperationFailed | Internal system error with the database operation, which may be update, insert, select, etc. |
| InvalidParameter.PermissionDenied | The API has no CAM permissions. |
| InvalidParameterValue.CheckNotPass | Business verification failed |
| InvalidParameterValue.ReplicationGroupNotExists | The global replication group doesn’t exist. |
| LimitExceeded.ReplicationGroupLocked | Replication group locked |
| ResourceNotFound.InstanceNotExists | No Redis instance is found by the serialId. |
| ResourceUnavailable.InstanceStatusError | Operation unsupported: the instance is exceptional. |
| UnsupportedOperation.Inspection | Inspecting replication group |
| UnsupportedOperation.InstanceNotOperation | Unsupported operation |
フィードバック