恢复冷备份数据 - RecoverData
功能介绍
恢复扫描结果数据。某个分支任务长时间未扫描过，扫描结果数据会被备份后删除，本接口可以对这类分支任务的数据进行恢复。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| codeartscheck:task:updateReportStatus | Write | task * | - | - | - |
| - | codeartscheck:ProjectId |
URI
POST /v1/task/recover-data
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Language | 否 | String | 参数解释： 语言，决定响应以哪种语言返回。 约束限制： 不涉及。 取值范围： 默认取值： zh-cn。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| [数组元素] | 是 | Array of ToRecoverTask objects | 参数解释： 恢复冷备份数据请求体。 约束限制： 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| taskId | 是 | String | 参数解释： 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制： 不涉及。 取值范围： 长度为[1~32]个字符。 默认取值： 不涉及。 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释： 响应状态。 取值范围： |
| result | Array of RecoverResult objects | 参数解释： 任务是否开始恢复数据。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| taskId | String | 参数解释： 任务ID。 取值范围： 长度为[1~32]个字符。 |
| allowRecover | Boolean | 参数解释： 是否开始恢复数据。 取值范围： |
| reason | String | 参数解释： 无法恢复数据的原因。 取值范围： 不涉及。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
| error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
| error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
请求示例
开始恢复ID为897acf5exxx48a5013cd的任务扫描结果数据
POST https://{endpoint}/v1/task/recover-data
[ {
"taskId" : "897acf5exxx48a5013cd"
} ] 响应示例
状态码：200
请求成功!
{
"status" : "success",
"error" : null,
"result" : [ {
"taskId" : "897acf5exxx48a5013cd",
"allowRecover" : true,
"reason" : null
} ]
} 状态码：400
请求异常。
{
"error_code" : "CC.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
} 状态码：401
权限不足。
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功! |
| 400 | 请求异常。 |
| 401 | 权限不足。 |
错误码
请参见错误码。
