tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeBackupFiles

最后更新时间：2023-06-26 15:13:12

1. API Description

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

This API is used to query the list of backup files.

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: DescribeBackupFiles.
Version Yes String Common Params. The value used for this API: 2018-04-11.
Region No String Common Params. This parameter is not required for this API.
InstanceId No String Query by instance ID
ShardId No String Query by shard ID
BackupType No String Backup type. Valid values: Data (data backup), Binlog (Binlog backup), Errlog (error log), Slowlog (slow log).
StartTime No String Query by start time
EndTime No String Query by end time
Limit No Integer Pagination parameter
Offset No Integer Pagination parameter
OrderBy No String Sorting dimension. Valid values: Time, Size.
OrderType No String Sorting order. Valid values: DESC, ASC.

3. Output Parameters

Parameter Name Type Description
Files Array of InstanceBackupFileItem List of backup files
TotalCount Integer Total number
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 None

Input Example

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

{}

Output Example

{
    "Response": {
        "Files": [
            {
                "BackupType": "Binlog",
                "EndTime": "2022-05-23 09:16:18",
                "FileName": "binlog+1653031073+20220520+151753+3085689978+binlog.000003.lz4",
                "FilePath": "cos_backup/tdsql/group_1652793502_8559507/set_1652793624_1/binlog/2022-05-20/binlog+1653031073+20220520+151753+3085689978+binlog.000003.lz4",
                "FileSize": 30537563,
                "InstanceId": "dcdbt-21dfpcv1",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "shard-ngbrea6b",
                "StartTime": "2022-05-20 15:17:53"
            },
            {
                "BackupType": "Binlog",
                "EndTime": "2022-05-22 21:33:53",
                "FileName": "binlog+1653010199+20220520+092959+3085680764+binlog.000003.lz4",
                "FilePath": "cos_backup/tdsql/group_1652793502_8559507/set_1652793754_3/binlog/2022-05-20/binlog+1653010199+20220520+092959+3085680764+binlog.000003.lz4",
                "FileSize": 31018905,
                "InstanceId": "dcdbt-21dfpcv1",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "shard-5zf65smf",
                "StartTime": "2022-05-20 09:29:59"
            },
            {
                "BackupType": "Data",
                "EndTime": "2022-05-20 00:20:06",
                "FileName": "cos_xtrabackup+1652977196+20220520+001956+3085689978+xbstream.lz4",
                "FilePath": "cos_backup/tdsql/group_1652793502_8559507/set_1652793624_1/xtrabackup/2022-05-20/cos_xtrabackup+1652977196+20220520+001956+3085689978+xbstream.lz4",
                "FileSize": 165413701,
                "InstanceId": "dcdbt-21dfpcv1",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "shard-ngbrea6b",
                "StartTime": "2022-05-20 00:19:56"
            },
            {
                "BackupType": "Data",
                "EndTime": "2022-05-20 00:06:18",
                "FileName": "cos_xtrabackup+1652976368+20220520+000608+3085680764+xbstream.lz4",
                "FilePath": "cos_backup/tdsql/group_1652793502_8559507/set_1652793754_3/xtrabackup/2022-05-20/cos_xtrabackup+1652976368+20220520+000608+3085680764+xbstream.lz4",
                "FileSize": 174847785,
                "InstanceId": "dcdbt-21dfpcv1",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "shard-5zf65smf",
                "StartTime": "2022-05-20 00:06:08"
            },
            {
                "BackupType": "Binlog",
                "EndTime": "2022-05-20 15:18:04",
                "FileName": "binlog+1652793627+20220517+212027+3085689978+binlog.000002.lz4",
                "FilePath": "cos_backup/tdsql/group_1652793502_8559507/set_1652793624_1/binlog/2022-05-17/binlog+1652793627+20220517+212027+3085689978+binlog.000002.lz4",
                "FileSize": 30809729,
                "InstanceId": "dcdbt-21dfpcv1",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "shard-ngbrea6b",
                "StartTime": "2022-05-17 21:20:27"
            }
        ],
        "RequestId": "d30ef4e8-d99d-4502-a870-196592035794",
        "TotalCount": 5
    }
}

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
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款