DescribeBinlogs

Download PDF

Last updated: 2024-11-20 11:13:51

DescribeBinlogs

Last updated: 2024-11-20 11:13:51

Download PDF

1. API Description

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

This API is used to query the list of binlog files of a TencentDB instance.

A maximum of 100 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: DescribeBinlogs.
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.
InstanceId	Yes	String	Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.
Offset	No	Integer	Offset. Minimum value: 0.
Limit	No	Integer	Number of entries per page. Value range: 1-100. Default value: 20.
MinStartTime	No	String	The earliest start time of binlog in the format of 2016-03-17 02:10:37.
MaxStartTime	No	String	The latest start time of binlog in the format of 2016-03-17 02:10:37.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Number of eligible log files.
Items	Array of BinlogInfo	Number of eligible binlog files.
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 binlog

This example shows you how to query a binlog.

Input Example

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

{
    "InstanceId": "cdb-c1nl9rpv"
}

Output Example

{
    "Response": {
        "Items": [
            {
                "BinlogFinishTime": "2020-11-12 21:13:12",
                "BinlogStartTime": "2020-11-12 21:13:04",
                "Date": "2020-11-12 21:13:35",
                "InternetUrl": "https://*****",
                "IntranetUrl": "https://*****",
                "Name": "cdb73977_binlog_mysqlbin.000004",
                "Size": 505,
                "Status": "FINISHED",
                "Region": "ap-guangzhou",
                "CosStorageType": 0,
                "RemoteInfo": [],
                "Type": "binlog",
                "InstanceId": "cdb-xxx"
            },
            {
                "BinlogFinishTime": "2020-11-12 21:13:04",
                "BinlogStartTime": "2020-11-02 11:38:49",
                "Date": "2020-11-12 21:13:25",
                "InternetUrl": "https://*****",
                "IntranetUrl": "https://*****",
                "Name": "cdb73977_binlog_mysqlbin.000003",
                "Size": 4537,
                "Status": "FINISHED",
                "Region": "ap-guangzhou",
                "CosStorageType": 0,
                "RemoteInfo": [],
                "Type": "binlog",
                "InstanceId": "cdb-xxx"
            }
        ],
        "RequestId": "2d8504a5-157d-4753-a060-6464b0e875e5",
        "TotalCount": 2
    }
}

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	CAM signature/authentication error.
InternalError.CdbError	System error.
InternalError.DBError	Database exception
InternalError.DBOperationError	Database operation failed.
InternalError.DatabaseAccessError	Internal database error.
InternalError.HttpError	Exceptional HTTP request
InternalError.UnknownError	Unknown error
InvalidParameter	Parameter error.
InvalidParameter.InstanceNotFound	The instance does not exist.
InvalidParameterValue.InvalidParameterValueError	Invalid parameter value
OperationDenied	Operation denied.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud