- Release Notes
- User Tutorial
- Product Introduction
- Tencent Kernel TXSQL
- Purchase Guide
- Get Started
- Operation Guide
- Best Practice
- Usage Specifications of TencentDB for MySQL
- Configuring Application Automatic Reconnection
- Impact of Modifying MySQL Master Instance Parameters
- Limits on Automatic Conversion from MyISAM to InnoDB
- Creating VPCs for TencentDB for MySQL
- Enhancing Business Load Capacity with TencentDB for MySQL
- Building LAMP Stack for Web Application
- Building Drupal Website
- Calling MySQL APIs in Python
- White Paper
- Troubleshooting
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Backup APIs
- Task APIs
- Security APIs
- Data Import APIs
- Parameter APIs
- Instance APIs
- DescribeDBInstanceGTID
- CloseWanService
- SwitchForUpgrade
- CreateDBInstanceHour
- DescribeDBInstanceCharset
- ModifyDBInstanceVipVport
- ModifyDBInstanceProject
- IsolateDBInstance
- UpgradeDBInstanceEngineVersion
- DescribeDBInstances
- InitDBInstances
- DescribeDBInstanceRebootTime
- OpenWanService
- UpgradeDBInstance
- ModifyDBInstanceName
- DescribeDBZoneConfig
- RestartDBInstances
- OpenDBInstanceGTID
- DescribeDBSwitchRecords
- DescribeDBInstanceConfig
- ModifyAutoRenewFlag
- ModifyInstanceTag
- DescribeTagsOfInstanceIds
- ModifyTimeWindow
- DescribeTimeWindow
- DeleteTimeWindow
- AddTimeWindow
- OfflineIsolatedInstances
- ReleaseIsolatedDBInstances
- ModifyRoGroupInfo
- DescribeRoGroups
- BalanceRoGroupLoad
- DescribeDBInstanceInfo
- DescribeRoMinScale
- CreateRoInstanceIp
- StopDelayReplication
- StartDelayReplication
- ModifyRoType
- ModifyRoReplicationDelay
- SwitchDBInstanceMasterSlave
- SwitchDrInstanceToMaster
- CreateDeployGroup
- DeleteDeployGroups
- DescribeDeployGroupList
- ModifyNameOrDescByDpId
- Database APIs
- Account APIs
- Rollback APIs
- Monitoring APIs
- Log APIs
- Database Audit APIs
- Data Types
- Error Codes
- FAQs
- Service Agreement
- Notice
- Reference
- Glossary
- Contact Us
- Release Notes
- User Tutorial
- Product Introduction
- Tencent Kernel TXSQL
- Purchase Guide
- Get Started
- Operation Guide
- Best Practice
- Usage Specifications of TencentDB for MySQL
- Configuring Application Automatic Reconnection
- Impact of Modifying MySQL Master Instance Parameters
- Limits on Automatic Conversion from MyISAM to InnoDB
- Creating VPCs for TencentDB for MySQL
- Enhancing Business Load Capacity with TencentDB for MySQL
- Building LAMP Stack for Web Application
- Building Drupal Website
- Calling MySQL APIs in Python
- White Paper
- Troubleshooting
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Backup APIs
- Task APIs
- Security APIs
- Data Import APIs
- Parameter APIs
- Instance APIs
- DescribeDBInstanceGTID
- CloseWanService
- SwitchForUpgrade
- CreateDBInstanceHour
- DescribeDBInstanceCharset
- ModifyDBInstanceVipVport
- ModifyDBInstanceProject
- IsolateDBInstance
- UpgradeDBInstanceEngineVersion
- DescribeDBInstances
- InitDBInstances
- DescribeDBInstanceRebootTime
- OpenWanService
- UpgradeDBInstance
- ModifyDBInstanceName
- DescribeDBZoneConfig
- RestartDBInstances
- OpenDBInstanceGTID
- DescribeDBSwitchRecords
- DescribeDBInstanceConfig
- ModifyAutoRenewFlag
- ModifyInstanceTag
- DescribeTagsOfInstanceIds
- ModifyTimeWindow
- DescribeTimeWindow
- DeleteTimeWindow
- AddTimeWindow
- OfflineIsolatedInstances
- ReleaseIsolatedDBInstances
- ModifyRoGroupInfo
- DescribeRoGroups
- BalanceRoGroupLoad
- DescribeDBInstanceInfo
- DescribeRoMinScale
- CreateRoInstanceIp
- StopDelayReplication
- StartDelayReplication
- ModifyRoType
- ModifyRoReplicationDelay
- SwitchDBInstanceMasterSlave
- SwitchDrInstanceToMaster
- CreateDeployGroup
- DeleteDeployGroups
- DescribeDeployGroupList
- ModifyNameOrDescByDpId
- Database APIs
- Account APIs
- Rollback APIs
- Monitoring APIs
- Log APIs
- Database Audit APIs
- Data Types
- Error Codes
- FAQs
- Service Agreement
- Notice
- Reference
- Glossary
- Contact Us
1. API Description
Domain name for API request: cdb.tencentcloudapi.com.
This API is used to query the data backup overview of a user in the current region.
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: DescribeDataBackupOverview. |
| Version | Yes | String | Common parameter. The value used for this API: 2017-03-20. |
| Region | Yes | String | Common parameter. 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 |
|---|---|---|
| DataBackupVolume | Integer | Total capacity of data backups in bytes in the current region (including automatic backups and manual backups). |
| DataBackupCount | Integer | Total number of data backups in the current region. |
| AutoBackupVolume | Integer | Total capacity of automatic backups in the current region. |
| AutoBackupCount | Integer | Total number of automatic backups in the current region. |
| ManualBackupVolume | Integer | Total capacity of manual backups in the current region. |
| ManualBackupCount | Integer | Total number of manual backups in the current region. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 DescribeDataBackupOverview
Input Example
https://cdb.tencentcloudapi.com/?Action=DescribeDataBackupOverview
&Product=mysql
&<Common request parameters>
Output Example
{
"Response": {
"AutoBackupCount": 3,
"AutoBackupVolume": 3000,
"DataBackupCount": 5,
"DataBackupVolume": 5000,
"ManualBackupCount": 2,
"ManualBackupVolume": 2000,
"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 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 |
|---|---|
| InternalError.CdbError | System error. |
| InvalidParameterValue.InvalidParameterValueError | Invalid parameter value |
Yes
No
Was this page helpful?