- Updates and Announcements
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Operation Overview
- Instance Management and Maintenance
- Upgrading Instances
- Managing Multiple AZs
- Backup and Restoration
- Data Migration
- Account and Password
- Parameter Configuration
- Disabling Commands
- Network and Security
- Monitoring and Alarming
- Troubleshooting
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Backup and Restoration APIs
- Instance APIs
- UpgradeInstance
- ResetPassword
- RenewInstance
- ModifyAutoBackupConfig
- DescribeInstances
- DescribeAutoBackupConfig
- ClearInstance
- ModfiyInstancePassword
- CreateInstances
- DescribeTaskInfo
- DescribeInstanceDealDetail
- ModifyInstance
- RestoreInstance
- ModifyNetworkConfig
- EnableReplicaReadonly
- DisableReplicaReadonly
- DestroyPrepaidInstance
- DestroyPostpaidInstance
- DescribeInstanceShards
- CleanUpInstance
- DescribeSlowLog
- ModifyInstanceAccount
- DescribeInstanceAccount
- DeleteInstanceAccount
- CreateInstanceAccount
- DescribeTaskList
- DescribeInstanceDTSInfo
- StartupInstance
- InquiryPriceUpgradeInstance
- InquiryPriceCreateInstance
- UpgradeInstanceVersion
- ModifyMaintenanceWindow
- DescribeMaintenanceWindow
- DescribeProxySlowLog
- DescribeInstanceNodeInfo
- DescribeTendisSlowLog
- DescribeInstanceZoneInfo
- UpgradeVersionToMultiAvailabilityZones
- ChangeReplicaToMaster
- KillMasterGroup
- DescribeParamTemplateInfo
- Region APIs
- Parameter Management APIs
- Monitoring and Management APIs
- Other APIs
- Data Types
- Error Codes
- FAQ
- Service Agreement
- Glossary
- Contact Us
- Updates and Announcements
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Operation Overview
- Instance Management and Maintenance
- Upgrading Instances
- Managing Multiple AZs
- Backup and Restoration
- Data Migration
- Account and Password
- Parameter Configuration
- Disabling Commands
- Network and Security
- Monitoring and Alarming
- Troubleshooting
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Backup and Restoration APIs
- Instance APIs
- UpgradeInstance
- ResetPassword
- RenewInstance
- ModifyAutoBackupConfig
- DescribeInstances
- DescribeAutoBackupConfig
- ClearInstance
- ModfiyInstancePassword
- CreateInstances
- DescribeTaskInfo
- DescribeInstanceDealDetail
- ModifyInstance
- RestoreInstance
- ModifyNetworkConfig
- EnableReplicaReadonly
- DisableReplicaReadonly
- DestroyPrepaidInstance
- DestroyPostpaidInstance
- DescribeInstanceShards
- CleanUpInstance
- DescribeSlowLog
- ModifyInstanceAccount
- DescribeInstanceAccount
- DeleteInstanceAccount
- CreateInstanceAccount
- DescribeTaskList
- DescribeInstanceDTSInfo
- StartupInstance
- InquiryPriceUpgradeInstance
- InquiryPriceCreateInstance
- UpgradeInstanceVersion
- ModifyMaintenanceWindow
- DescribeMaintenanceWindow
- DescribeProxySlowLog
- DescribeInstanceNodeInfo
- DescribeTendisSlowLog
- DescribeInstanceZoneInfo
- UpgradeVersionToMultiAvailabilityZones
- ChangeReplicaToMaster
- KillMasterGroup
- DescribeParamTemplateInfo
- Region APIs
- Parameter Management APIs
- Monitoring and Management APIs
- Other APIs
- Data Types
- Error Codes
- FAQ
- Service Agreement
- Glossary
- Contact Us
1. API Description
Domain name for API request: redis.tencentcloudapi.com.
This API is used to clear the data of a Redis instance.
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 parameter. The value used for this API: ClearInstance. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-04-12. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID |
| Password | No | String | Redis instance password (this parameter is not required for password-free instances but for password-enabled instances) |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | Integer | Task ID |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Sample request
Input Example
https://redis.tencentcloudapi.com/?Action=ClearInstance
&InstanceId=crs-5a4py64p
&Password=zy456987
&<Common request parameters>
Output Example
{
"Response": {
"TaskId": 16658,
"RequestId": "d893c0ac-db57-4e5c-8335-e787b77403b2"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
| 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. |
| UnauthorizedOperation.NoCAMAuthed | No CAM permissions. |
Yes
No
Was this page helpful?