文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 代码问题/ 查询备份恢复状态 - GetBackupInfo
更新时间：2026-06-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询备份恢复状态 - GetBackupInfo

功能介绍

查询分支任务恢复进度以及备份状态。某个分支任务长时间未扫描过，扫描结果数据会被备份后删除，本接口可以查询分支任务的备份状态和恢复进度。

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck:task:updateReportStatus

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v2/backup/backup-infos

表1 Query参数

参数

是否必选

参数类型

描述

task_id

是

String

参数解释：

任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。

约束限制：

不涉及。

取值范围：

长度为[1~32]个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

否

String

参数解释：

语言，决定响应以哪种语言返回。

约束限制：

不涉及。

取值范围：

  • zh-cn：中文。

  • en-us：英文。

默认取值：

zh-cn。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释：

响应状态。

取值范围：

  • success：成功。

  • error：失败。

result

Array of BackupInfo objects

参数解释：

任务的恢复进度以及备份状态。
表4 BackupInfo

参数

参数类型

描述

taskId

String

参数解释：

任务ID。

取值范围：

长度为[1~32]个字符。

backupStatus

String

参数解释：

任务的备份状态。

取值范围：

  • SUCCESS：成功备份。

  • FAILED：备份失败。

  • WAITTING：备份中。

backupTime

String

参数解释：

任务数据被备份的时间。使用UTC时间，格式为yyyy-MM-dd HH:mm:ss。例如：2020-09-25 12:05:00。

取值范围：

不涉及。

recoverStatus

String

参数解释：

任务的恢复状态。

取值范围：

  • SUCCESS：成功恢复。

  • FAILED：恢复失败。

  • WAITTING：备份中。

recoverTime

String

参数解释：

任务数据被恢复的时间。使用UTC时间，格式为yyyy-MM-dd HH:mm:ss。例如：2020-09-25 12:05:00。

取值范围：

不涉及。

region

String

参数解释：

废弃字段。

取值范围：

不涉及。

progress

String

参数解释：

任务数据恢复的进度。例如100，表示已完成100%。

取值范围：

1~100。

backupType

String

参数解释：

废弃字段。

取值范围：

不涉及。

cleanStatus

String

参数解释：

废弃字段。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

请求示例

查询ID为897acf5exxx48a5013cd的任务的恢复进度以及备份状态

GET https://{endpoint}/v2/backup/backup-infos?task_id=897acf5exxx48a5013cd

响应示例

状态码：200

请求成功!

{
  "status" : "success",
  "error" : null,
  "result" : {
    "taskId" : "897acf5exxx48a5013cd",
    "backupStatus" : "SUCCESS",
    "backupTime" : "2026-01-15 16:31:45",
    "recoverStatus" : "FAILED",
    "recoverTime" : "2026-01-15 16:32:30",
    "region" : null,
    "progress" : 0,
    "backupType" : "schedule",
    "cleanStatus" : "todo"
  }
}

状态码：400

请求异常。

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}

状态码：401

权限不足。

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

请求成功!

400

请求异常。

401

权限不足。

错误码

请参见错误码。

父主题： 代码问题

相关文档