云数据库 MariaDB 查看备份文件列表-备份与恢复相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： mariadb.tencentcloudapi.com 。

本接口(DescribeBackupFiles)用于查看备份文件列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBackupFiles。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	否	String	按实例ID查询示例值：tdsql-xxx
BackupType	否	String	备份类型，Data:数据备份，Binlog:Binlog备份，Errlog:错误日志，Slowlog:慢日志示例值：Binlog
StartTime	否	String	按开始时间查询示例值：2022-05-10 12:00:00
EndTime	否	String	按结束时间查询示例值：2022-05-10 12:00:00
Limit	否	Integer	分页参数示例值：10
Offset	否	Integer	分页参数示例值：0
OrderBy	否	String	排序参数，可选值：Time,Size 示例值：Time
OrderType	否	String	排序参数, 可选值：DESC,ASC 示例值：DESC

3. 输出参数

参数名称	类型	描述
Files	Array of InstanceBackupFileItem	备份文件列表
TotalCount	Integer	总条目数
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 无

输入示例

POST / HTTP/1.1
Host: mariadb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBackupFiles
<公共请求参数>

{}

输出示例

{
    "Response": {
        "Files": [
            {
                "BackupType": "Data",
                "EndTime": "2022-05-20 00:02:19",
                "FileName": "cos_xtrabackup+1652976129+20220520+000209+3085636221+xbstream.lz4",
                "FilePath": "cos_backup/tdsql/set_1652843814_8559529/xtrabackup/2022-05-20/cos_xtrabackup+1652976129+20220520+000209+3085636221+xbstream.lz4",
                "FileSize": 48721218,
                "InstanceId": "tdsql-lyzax5rb",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "",
                "StartTime": "2022-05-20 00:02:09"
            },
            {
                "BackupType": "Data",
                "EndTime": "2022-05-19 00:23:03",
                "FileName": "cos_xtrabackup+1652890972+20220519+002252+3085636221+xbstream.lz4",
                "FilePath": "cos_backup/tdsql/set_1652843814_8559529/xtrabackup/2022-05-19/cos_xtrabackup+1652890972+20220519+002252+3085636221+xbstream.lz4",
                "FileSize": 47738611,
                "InstanceId": "tdsql-lyzax5rb",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "",
                "StartTime": "2022-05-19 00:22:52"
            },
            {
                "BackupType": "Data",
                "EndTime": "2022-05-18 11:44:52",
                "FileName": "cos_xtrabackup+1652845485+20220518+114445+3085636221+xbstream.lz4",
                "FilePath": "cos_backup/tdsql/set_1652843814_8559529/xtrabackup/2022-05-18/cos_xtrabackup+1652845485+20220518+114445+3085636221+xbstream.lz4",
                "FileSize": 10281128,
                "InstanceId": "tdsql-lyzax5rb",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "",
                "StartTime": "2022-05-18 11:44:45"
            },
            {
                "BackupType": "Binlog",
                "EndTime": "2022-05-20 17:13:31",
                "FileName": "binlog+1652843821+20220518+111701+3085636221+binlog.000002.lz4",
                "FilePath": "cos_backup/tdsql/set_1652843814_8559529/binlog/2022-05-18/binlog+1652843821+20220518+111701+3085636221+binlog.000002.lz4",
                "FileSize": 51119079,
                "InstanceId": "tdsql-lyzax5rb",
                "InstanceName": "test-name",
                "InstanceStatus": 2,
                "ManualBackup": 0,
                "ShardId": "",
                "StartTime": "2022-05-18 11:17:01"
            }
        ],
        "RequestId": "dce77e5f-57b9-4df5-9889-1a4b9f318659",
        "TotalCount": 4
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter.ActionNotFound	接口没有找到。
UnauthorizedOperation.PermissionDenied	没有权限操作该接口或资源。

查看备份文件列表

本页目录：