TencentDB for Redis®
- Release Notes and Announcements
- Product Introduction
- Product Series
- Purchase Guide
- Getting Started
- Operation Guide
- Access Management
- SDK Connection
- Daily Instance Operation
- Upgrading Redis Edition Instances
- Managing Redis Edition Nodes
- Multi-AZ Deployment Management
- Backup and Restoration
- Downloading Redis Edition Backups
- Data Migration for Redis Edition Instances
- Account and Password (Redis Edition)
- Parameter Configuration
- Redis Parameter Operations
- Network and Security
- Monitoring and Alarms
- Redis Edition Event Management
- Global Replication for Redis Edition
- Performance Optimization
- Development Guidelines
- Connection Pool Configuration
- Command Reference
- Commands Supported by Different Versions
- Additional Command Operations in the Redis Edition
- Troubleshooting
- Connection Exception
- Performance Troubleshooting and Fine-Tuning
- Practical Tutorial
- API Documentation
- Making API Requests
- Instance APIs
- Parameter Management APIs
- Other APIs
- Backup and Restoration APIs
- Monitoring and Management APIs
- Service Agreement
DocumentationTencentDB for Redis®API DocumentationBackup and Restoration APIsDescribeInstanceBackups
DescribeInstanceBackups
Last updated: 2024-12-04 11:19:37
1. API Description
Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to query the backup list of an instance.
A maximum of 50 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: DescribeInstanceBackups. |
| 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. |
| Limit | No | Integer | Number of backups returned per page. Default value: 20. Maximum value: 100. |
| Offset | No | Integer | Pagination offset, which is an integral multiple of Limit. offset = limit * (page number - 1). |
| InstanceId | No | String | ID of the instance to be operated on, which can be obtained through the InstanceId field in the return value of the DescribeInstance API. |
| BeginTime | No | String | Start time for a query, for example, in the format of 2017-02-08 16:46:34, with a maximum query span of 30 days. You can query the list of instances backed up within the [beginTime, endTime] period. |
| EndTime | No | String | End time for a query, for example, in the format of 2017-02-08 19:09:26, with a maximum query span of 30 days. You can query the list of instances backed up within the [BeginTime, EndTime] period. |
| Status.N | No | Array of Integer | Backup task status:1: The backup is in the process.2: The backup is normal.3: The backup is being converted to an RDB file.4: Conversion to RDB has been completed.-1: The backup expired.-2: The backup has been deleted. |
| InstanceName | No | String | Instance name, which can be fuzzily searched. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of backups. |
| BackupSet | Array of RedisBackupSet | Array of instance backups. |
| 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 1
This example shows you how to query the backup list of the instance crs-c7nuafdt.
Input Example
POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceBackups
<Common request parameters>
{
"Status": [
"2"
],
"InstanceId": "crs-c7nuafdt",
"Limit": "10",
"Offset": "0"
}
Output Example
{
"Response": {
"BackupSet": [
{
"BackupId": "154572601-1165734322-153731238",
"BackupSize": 191,
"BackupType": "0",
"EndTime": "2022-12-23 16:25:18",
"ExpireTime": "2022-12-30 16:24:41",
"FileType": "RDB-Redis 4.0",
"FullBackup": 0,
"InstanceId": "crs-c7nuafdt",
"InstanceName": "Backup test",
"InstanceType": 6,
"Locked": 0,
"Region": "ap-guangzhou",
"Remark": "test001",
"StartTime": "2022-12-23 16:24:41",
"Status": 2
}
],
"RequestId": "2a95bfa4-ac8c-43cd-b7b1-5a93817d8de2",
"TotalCount": 1
}
}
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 Node.js
- 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. |
| InternalError.DbOperationFailed | Internal system error with the database operation, which may be update, insert, select, etc. |
| InternalError.InternalError | Internal error. |
| InvalidParameter.InvalidParameter | Invalid service parameter. |
| InvalidParameter.PermissionDenied | The API has no CAM permissions. |
| ResourceNotFound.InstanceNotExists | No Redis instance is found by the serialId. |
| UnauthorizedOperation.NoCAMAuthed | No CAM permissions. |
| UnsupportedOperation | The operation is not supported. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No