tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDBLogFiles

Last updated: 2023-06-21 15:55:41

1. API Description

Domain name for API request: mariadb.tencentcloudapi.com.

This API is used to get the list of various logs of a database, including cold backups, binlogs, errlogs, and slowlogs.

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: DescribeDBLogFiles.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
InstanceId Yes String Instance ID in the format of tdsql-ow728lmc.
Type Yes Integer Requested log type. Valid values: 1 (binlog), 2 (cold backup), 3 (errlog), 4 (slowlog).

3. Output Parameters

Parameter Name Type Description
InstanceId String Instance ID in the format of tdsql-ow728lmc.
Type Integer Requested log type. Valid values: 1 (binlog), 2 (cold backup), 3 (errlog), 4 (slowlog).
Total Integer Total number of requested logs
Files Array of LogFileInfo Information such as uri, length, and mtime (modification time)
VpcPrefix String For an instance in a VPC, this prefix plus URI can be used as the download address
NormalPrefix String For an instance in a common network, this prefix plus URI can be used as the download address
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the binlog list

Input Example

https://mariadb.tencentcloudapi.com/?Action=DescribeDBLogFiles
&InstanceId=tdsql-ow728lmc
&Type=1
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "7212a9ec-a235-2144-98d4-59fbe6f14d79",
        "InstanceId": "tdsql-ow728lmc",
        "Type": 1,
        "Total": 1,
        "Files": [
            {
                "Uri": "/1/noshard_108/set_1468578840_203059/1468578832/859932065/000001/5ce7d1a8f26c2dfcf1de22d4e9792b11b0b0057450684d266e1bf9a8aa6ea272",
                "Length": 5253724,
                "Mtime": 1468822981,
                "FileName": "slave-log"
            }
        ],
        "VpcPrefix": "http://169.254.0.27:8083",
        "NormalPrefix": "http://10.66.255.253:8083"
    }
}

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

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.OssOperationFailed Failed to request the backend API.
InternalError.CosConfiguration Invalid COS address configuration.
InternalError.CosSignUrl Backup file signature failed.
InternalError.DbOperationFailed Failed to query the database.
InternalError.GetInstanceInfoFailed Failed to get the backend instance information.
InternalError.HDFSError Failed to read the backup file.
InternalError.InnerConfigurationMissing Missing internal configuration.
InvalidParameter.InstanceNotFound Failed to find the requested instance.
InvalidParameter.ShardResourceIdNotFound The instance shard does not exist.
ResourceUnavailable.CosApiFailed An error occurred while calling COS APIs.
ResourceUnavailable.InstanceAlreadyDeleted The database instance has been deleted.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy