TencentDB for MySQL
- Release Notes and Announcements
- Announcements
- Product Introduction
- Database Architecture
- Database Instance
- Kernel Features
- Kernel Version Release Notes
- Functionality Features
- Performance Features
- Parallel Query
- Security Features
- Stability Features
- Purchase Guide
- Getting Started
- Connecting to MySQL Instance
- Database Audit
- Audit Rule Template
- MySQL Cluster Edition
- Maintenance Management Instance
- Operation Guide
- Instance Management and Maintenance
- Instance Upgrade
- CPU Elastic Expansion
- Read-Only/Disaster Recovery Instances
- Database Proxy
- Database Proxy Kernel Features
- Database Proxy Management
- Automatic Read/Write Separation Feature
- Connection Pool Feature
- Other Features
- Account Management
- Database Management Center (DMC)
- Parameter Configuration
- Network and Security
- Backup and Rollback
- Restoring Database from Backup File
- Monitoring and Alarms
- Operation Logs
- Practical Tutorial
- Calling MySQL APIs in Python
- White Paper
- Performance White Paper
- Performance Test Report
- Troubleshooting
- Connections
- API Documentation
- Data Import APIs
- Rollback APIs
- Parameter APIs
- Making API Requests
- Instance APIs
- Database Proxy APIs
- Database Audit APIs
- Security APIs
- Account APIs
- Backup APIs
- Database APIs
- Monitoring APIs
- Log-related API
- FAQs
- Backup
- Connection and Login
- Instance Upgrade
- Performance and Memory
- Service Agreement
- Reference
DescribeBackupOverview
Last updated: 2024-11-20 11:15:49
1. API Description
Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to query the backup overview of a user. It will return the user's current total number of backups, total capacity used by backups, capacity in the free tier, and paid capacity (all capacity values are in bytes).
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: DescribeBackupOverview. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Product | Yes | String | TencentDB product type to be queried. Currently, only mysql is supported. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| BackupCount | Integer | Total number of backups of a user in the current region (including data backups and log backups). |
| BackupVolume | Integer | Total capacity of backups of a user in the current region. |
| BillingVolume | Integer | Paid capacity of backups of a user in the current region, i.e., capacity that exceeds the free tier. |
| FreeVolume | Integer | Backup capacity in the free tier of a user in the current region. |
| RemoteBackupVolume | Integer | Total capacity of backups of a user in the current region Note: This field may return null, indicating that no valid value can be obtained. |
| BackupArchiveVolume | Integer | Archive backup capacity, which includes data backups and log backups. Note: This field may return null, indicating that no valid value can be obtained. |
| BackupStandbyVolume | Integer | Backup capacity of standard storage, which includes data backups and log backups. Note: This field may return null, indicating that no valid value can be obtained. |
| 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 Querying backup overview
Input Example
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupOverview
<Common request parameters>
{
"Product": "mysql"
}
Output Example
{
"Response": {
"BackupCount": 15,
"BackupVolume": 90000,
"BillingVolume": 20000,
"FreeVolume": 70000,
"RemoteBackupVolume": 1000,
"BackupArchiveVolume": 1000,
"BackupStandbyVolume": 1000,
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
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 |
|---|---|
| AuthFailure.SubAccountDenied | The sub-account has no permissions. |
| InternalError.CdbError | System error. |
| InternalError.InternalHttpServerError | An exception occurred while executing the request. |
| InvalidParameter | Parameter error. |
| InvalidParameter.ControllerNotFoundError | This API was not found. |
| InvalidParameterValue.InvalidParameterValueError | Invalid parameter value |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No