查询转储任务列表 - ListBackupTransfers
调试
您可以在API Explorer中调试该接口。
授权信息
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
| 授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| rds:backup:list | - | - | - | - | - |
URI
- 参数说明
表1 参数说明 名称
是否必选
参数类型
说明
project_id
是
String
参数解释：
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
offset
是
Integer
参数解释：
分页页码。
约束限制：
不涉及。
取值范围：
最小值为1，表示查询第1页。
默认取值：
1
limit
是
Integer
参数解释：
每页展示条数。
约束限制：
不涉及。
取值范围：
最小值为0。
默认取值：
10
表2 参数说明 名称
是否必选
参数类型
说明
order_field
否
String
参数解释：
排序字段。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
order_rule
否
String
参数解释：
排序规则。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
filter_field
否
String
参数解释：
筛选字段。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
filter_content
否
String
参数解释：
筛选关键字。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
begin_time
否
Long
参数解释：
开始时间戳。单位：毫秒。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
end_time
否
Long
参数解释：
结束时间戳。单位：毫秒。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
transfer_type
否
String
参数解释：
转储任务类型。
约束限制：
不涉及。
取值范围：
- manual：手动转储任务。
- auto：自动转储任务。
默认取值：
manual
请求消息
无。
请求示例
查询转储任务列表。
GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/transfer-info 响应消息
- 正常响应要素说明
表3 要素说明 参数
参数类型
描述
total
Long
参数解释：
任务数量。
取值范围：
不涉及。
transfer_list
Array of objects
参数解释：
任务列表。详情请参见表4。
表4 transfer_list字段说明 名称
参数类型
说明
id
String
参数解释：
备份ID。
取值范围：
不涉及。
name
String
参数解释：
备份名称。
取值范围：
不涉及。
begin_time
Long
参数解释：
开始时间。单位：毫秒。
取值范围：
不涉及。
end_time
Long
参数解释：
结束时间。单位：毫秒。
取值范围：
不涉及。
status
String
参数解释：
任务状态。
取值范围：
- Pending：挂起。
- Running：运行中。
- Completed：已完成。
- Failed：已失败。
size
Double
参数解释：
对象大小，单位为KByte。
取值范围：
不涉及。
instance_id
String
参数解释：
实例ID。
取值范围：
不涉及。
file_name
String
参数解释：
目标对象名称。
取值范围：
不涉及。
destination
String
参数解释：
目标桶名。
取值范围：
不涉及。
engine_name
String
参数解释：
引擎名称。
取值范围：
- mysql
- postgresql
- sqlserver
type
String
参数解释：
转储备份类型。
取值范围：
- Db：自动备份。
- log：增量备份。
- snapshot：手动备份。
- 正常响应样例
{ "total": 1, "transfer_list": [ { "id": "5eeaa082817e4659a2dc1acbd16e1a38br03", "name": "postgresql-rds-43de5c0a-20261013062044789", "begin_time": 1791947429892, "end_time": 1791947439463, "status": "Completed", "size": 3576.19336, "type": "Db", "instance_id": "0436304cef5748a9b9f28d409141fd8din03", "file_name": "a8e531baf4804b0a840e1b98cd146caf_0436304cef5748a9b9f28d409141fd8din03_Db_5eeaa082817e4659a2dc1acbd16e1a38br03_20261013061946403_20261013062044754_871b357a85bf4755ad53c6798abf8099no03_.tar.gz", "destination": "obs-test", "engine_name": "postgresql" } ] } - 异常响应
请参见异常响应结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
