tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for Redis®Instance APIsKillMasterGroup
KillMasterGroup
Last updated: 2024-12-04 11:19:13
KillMasterGroup
Last updated: 2024-12-04 11:19:13

1. API Description

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

This API is used to simulate a fault.

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: KillMasterGroup.
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.
InstanceId Yes String ID of a specified instance, such as "crs-xjhsdj****" Log in to the Redis console and copy the instance ID in the instance list.
Password No String A parameter used to configure the access password for a specified instance. If password-free authentication is enabled, this parameter will not be required. Required password strength. - It must contains 8-30 characters. We recommend that you use a password of more than 12 characters. - It must contain at least two of the following types: lowercase letters, uppercase letters, digits, and symbols (()`~!@#$%^&*-+=_|{}[]:;<>,.?/), and it cannot start with a slash (/).
ShardIds.N No Array of Integer Sharded cluster ID, which can be obtained through ClusterId of the response parameter
Redis of the API DescribeInstanceNodeInfo.

3. Output Parameters

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.

4. Example

Example1 Sample request

This example shows you how to simulate a failure.

Input Example

POST / HTTP/1.1Host: redis.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: KillMasterGroup<Common request parameters>{    "InstanceId": "crs-joak5XXX",    "Password": "pwd@1234",    "ShardIds": [        0    ]}

Output Example

{
    "Response": {
        "RequestId": "da6b0bea-7aab-4d4b-b819-d524f4c9eXXX",
        "TaskId": 1682324000
    }
}

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
AuthFailure CAM signature/authentication error.
AuthFailure.InvalidAuthorization Invalid authorization.
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
FailedOperation.UnSupportError The instance does not support this API.
InternalError.InternalError Internal error.
InvalidParameter.IllegalParameterError Invalid parameter.
InvalidParameter.InvalidParameter Invalid service parameter.
InvalidParameter.PermissionDenied The API has no CAM permissions.
InvalidParameterValue.PasswordEmpty The password is empty.
InvalidParameterValue.PasswordError Password verification error due to incorrect password.
InvalidParameterValue.PasswordRuleError When the password is set, the old password passed in by MC does not match the previously set password.
ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
ResourceUnavailable.InstanceNotSupportOperation Instances in this status do not support the operation.
ResourceUnavailable.InstanceStatusError Operation unsupported: the instance is exceptional.
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