查询集合回档任务状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
mpserverless:QueryDBRestoreTaskStatus |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SpaceId |
string |
是 |
服务空间 ID。 |
0e16bb12-14af-4635-b24c-5ac1a9a***** |
| TaskId |
string |
是 |
任务 ID。 |
0150006d-ab93-4920-a63e-c011dea1e089 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| DetailMessage |
string |
任务失败时的错误信息。 |
SERVER_BUSY |
| DownloadUrl |
string |
备份文件下载链接,仅备份下载任务成功时非空。 |
https://example.com/backup.tar.gz |
| FailedCount |
integer |
回档失败的数据库记录数量。 |
1 |
| Phase |
string |
备份下载任务的阶段:PACKAGING 准备备份文件、UPLOADING 生成可下载文件、COMPLETED 准备完成。排队期间及回档任务可为空。 |
DOWNLOAD |
| Progress |
integer |
备份下载任务准备进度,范围 0–100。不是浏览器文件下载进度;原有回档任务返回 0。 |
100 |
| RequestId |
string |
唯一请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| Status |
string |
回档任务状态。可选值如下:
说明
注意任务状态变成 SUCCESS 或者 FAILED 都应该中止轮询。 |
SUCCESS |
| SuccessCount |
integer |
成功回档的数据库记录数量。 |
1 |
示例
正常返回示例
JSON格式
{
"DetailMessage": "SERVER_BUSY",
"DownloadUrl": "https://example.com/backup.tar.gz",
"FailedCount": 1,
"Phase": "DOWNLOAD",
"Progress": 100,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Status": "SUCCESS",
"SuccessCount": 1
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | TaskId.NotFound | The specified TaskId does not exist. | 指定的TaskId不存在。 |
| 400 | AccessDenied | You are not authorized to access this space. | 没有访问该Space的权限。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。