1. 接口描述
接口请求域名： mariadb.api3.fincloud.tencent.com。
查询备份文件列表。支持查询实例下包括xtrabackup、binlog、errlog、slowlog等几种备份文件
默认接口请求频率限制：20次/秒。
接口更新时间：2024-01-20 03:34:15。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeBackupFiles |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 否 | 是 | String | 实例ID 示例值： tdsql-c1nl9rpv |
| ShardId | 否 | 是 | String | 分片ID 示例值： “” |
| BackupType | 否 | 是 | String | 备份类型。目前支持Data,Binlog,Errlog,Slowlog这几种类型 示例值： Binlog |
| StartTime | 否 | 是 | String | 开始时间。格式示例为：2023-02-03 04:05:06 示例值： 2022-05-10 12:00:00 |
| EndTime | 否 | 是 | String | 结束时间。格式示例为：2023-02-03 04:05:06 示例值： 2022-05-10 12:00:00 |
| Limit | 否 | 否 | Int64 | 页大小。分页查询参数，最大1000 示例值： 10 |
| Offset | 否 | 否 | Int64 | 页码。分页查询参数 示例值： 0 |
| OrderBy | 否 | 是 | String | 查询结果排序参数。支持Time、Size 这几种类型 示例值： Time |
| OrderType | 否 | 是 | String | 排序参数, 可选值：DESC（降序）,ASC（升序） 示例值： DESC |
| Format | 否 | 是 | String | 返回的url格式类型。枚举类型，Base:无签名，PreSigned:带签名，控制台页面传Base 示例值： Base |
| StartETime | 否 | 否 | String | 开始时间。以备份文件结束时间查询。格式示例为：2023-02-03 04:05:06 示例值： 2023-02-03 04:05:06 |
| EndETime | 否 | 否 | String | 结束时间。以备份文件结束时间查询。格式示例为：2023-02-03 04:05:06 示例值： 2023-02-03 04:05:06 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 返回结果总数 示例值： 30 |
| Files | Array of InstanceBackupFileItem | 文件列表 示例值：查看 |
| UrlPrefix | String | 文件下载链接路径前缀 示例值： http://10.66.255.253:8083 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.InnerSystemError | 内部系统错误。 |
| InvalidParameter.IllegalParameterError | 非法参数。 |