tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for Redis®Instance APIsRemoveReplicationInstance
RemoveReplicationInstance
Last updated: 2024-12-04 11:19:06
RemoveReplicationInstance
Last updated: 2024-12-04 11:19:06

1. API Description

Domain name for API request: redis.intl.tencentcloudapi.com.

This API is used to remove instances from a replication group.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: RemoveReplicationInstance.
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, for example, crs-rpl-m3zt****. Log in to the Redis console and obtain it in the global replication group list.
InstanceId Yes String Specifies the instance ID. Example: crs-xjhsdj****. Log in to the TencentDB for Redis console and copy the instance ID in the instance list.
SyncType Yes Boolean Data synchronization type.
- true: Strong synchronization is required.
- false: Strong synchronization is not required, and only the primary instance can be deleted.

3. Output Parameters

Parameter Name Type Description
TaskId Integer Asynchronous 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.

4. Example

Example1 Removing Instances from a Replication Group

This example shows you how to remove instances from a replication group with strong synchronization as the data synchronization type.

Input Example

POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RemoveReplicationInstance
<Common request parameters>

{
    "InstanceId": "crs-sa5****",
    "SyncType": true,
    "GroupId": "crs-rpl-sa5****"
}

Output Example

{
    "Response": {
        "RequestId": "c4ed5948-d156-4931-b9c3-10133a0bb6c9",
        "TaskId": 10856
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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.
InternalError.DbOperationFailed Internal system error with the database operation, which may be update, insert, select, etc.
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
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support