DescribeDBLogFiles

Prev Next

search by keyword

Recent Pages

Documentation

Last updated: 2020-12-01 20:37:52

1. API Description

Domain name for API request: dcdb.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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dcdb.ap-shanghai-fsi.tencentcloudapi.com

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: DescribeDBLogFiles.
Version	Yes	String	Common parameter. The value used for this API: 2018-04-11.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID in the format of dcdbt-ow7t8lmc.
ShardId	Yes	String	Shard ID in the format of shard-7noic7tv
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 dcdbt-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	List of log files
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
ShardId	String	Shard ID in the format of shard-7noic7tv
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the list of logs

Input Example

https://dcdb.tencentcloudapi.com/?Action=DescribeDBLogFiles
&InstanceId=dcdbt-2t4cf98d
&ShardId=shard-gdqcdn39
&Type=1
&<Common request parameters>

Output Example

{
  "Response": {
    "Files": [
      {
        "Length": 5253724,
        "Mtime": 1468822981,
        "Uri": "/1/noshard_108/group_1520844319_37793941/1468578832/859932065/000001/5ce7d1a8f26c2dfcf1de22d4e9792b11b0b0057450684d266e1bf9a8aa6ea272/1/shard-5ps4rppj/set_1516333432_6"
      }
    ],
    "InstanceId": "dcdbt-2t4cf98d",
    "ShardId": "shard-gdqcdn39",
    "NormalPrefix": "http://10.66.255.253:8083",
    "RequestId": "7212a9ec-a235-2144-98d4-59fbe6f14d79",
    "Total": 1,
    "Type": 1,
    "VpcPrefix": "http://169.254.0.27: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

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
InternalError.CamAuthFailed	CAM authentication request failed.
InternalError.CosConfiguration	Invalid COS instance address configuration.
InternalError.CosSignUrl	Backup filename signature failed.
InternalError.DbOperationFailed	Failed to query the database.
InternalError.GetInstanceInfoFailed	Failed to get the instance information.
InvalidParameter.GenericParameterError	An error occurred while verifying parameter validity.
InvalidParameter.InstanceNotFound	Failed to find the requested instance.
ResourceNotFound.NoInstanceFound	The specified database instance was not found.
ResourceUnavailable.CosApiFailed	An error occurred while calling COS APIs.
ResourceUnavailable.InstanceAlreadyDeleted	The database instance has been dropped.
ResourceUnavailable.InstanceStatusAbnormal	Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied	You have no permission to manipulate this API or resource.

Recent Pages