查询备份文件列表
最近更新时间: 2024-09-03 18:49:57
1. 接口描述
接口请求域名： dcdb.api3.cloud.sunhongs.com。
查询备份文件列表
默认接口请求频率限制：20次/秒。
接口更新时间：2023-09-06 16:53:32。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeBackupFiles |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-11 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceId | 否 | 否 | String | 实例ID |
| ShardId | 否 | 否 | String | 分片ID |
| BackupType | 否 | 否 | String | 备份类型。目前支持Data,Binlog,Errlog,Slowlog这几种类型 |
| StartTime | 否 | 否 | String | 开始时间。格式示例为：2023-02-03 04:05:06 |
| EndTime | 否 | 否 | String | 结束时间。格式示例为：2023-02-03 04:05:06 |
| Limit | 否 | 否 | Int64 | 页大小。分页查询参数，最大1000 |
| Offset | 否 | 否 | Int64 | 页码。分页查询参数 |
| OrderBy | 否 | 是 | String | 查询结果排序参数。支持Time、Size 这几种类型 |
| OrderType | 否 | 是 | String | 查询结果排序类型参数。目前支持desc,asc,DESC,ASC这几种类型 |
| Format | 否 | 是 | String | 返回的url格式类型。枚举类型，Base:无签名，PreSigned:带签名，控制台页面传Base |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 返回结果总数 |
| Files | InstanceBackupFileItem | 文件列表 |
| UrlPrefix | String | 文件下载链接路径前缀 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.InnerSystemError | |
| InvalidParameter.IllegalParameterError |