DescribeBinlogBackupOverview

Download PDF

DescribeBinlogBackupOverview

最后更新时间：2024-11-20 11:15:47

下载PDF

1. API Description

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

This API is used to query the log 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 Params. The value used for this API: DescribeBinlogBackupOverview.
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
BinlogBackupVolume	Integer	Total capacity of log backups in bytes (including remote log backups)
BinlogBackupCount	Integer	Total number of log backups (include remote log backups)
RemoteBinlogVolume	Integer	Capacity of remote log backups in bytes
RemoteBinlogCount	Integer	Number of remote backups
BinlogArchiveVolume	Integer	Capacity of archive log backups in bytes
BinlogArchiveCount	Integer	Number of archived log backups
BinlogStandbyVolume	Integer	Log backup capacity of standard storage in bytes
BinlogStandbyCount	Integer	Number of log backups of standard storage
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 DescribeBinlogBackupOverview

Input Example

POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBinlogBackupOverview
<Common request parameters>

{
    "Product": "mysql"
}

Output Example

{
    "Response": {
        "BinlogBackupCount": 15,
        "BinlogBackupVolume": 6000,
        "RemoteBinlogCount": 5,
        "RemoteBinlogVolume": 2000,
        "BinlogArchiveCount": 5,
        "BinlogArchiveVolume": 2000,
        "BinlogStandbyCount": 5,
        "BinlogStandbyVolume": 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.

Command Line Interface

Tencent Cloud CLI 3.0

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.
InvalidParameter.ControllerNotFoundError	This API was not found.
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value
OperationDenied.SubAccountOperationDenied	The Tencent Cloud sub-account is not allowed to perform the operation due to insufficient permissions.

tencent cloud

Recent Pages

DescribeBinlogBackupOverview

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 DescribeBinlogBackupOverview

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

tencent cloud

注册

登录

Recent Pages

DescribeBinlogBackupOverview

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 DescribeBinlogBackupOverview

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？