Help Center/ CodeArts Check/ API Reference/ APIs/ Code Issues/ Restoring Cold Backup Data
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Restoring Cold Backup Data

Function

Restore the scanning result data. If a branch task is not scanned for a long time, the scanning result data will be backed up and then deleted. This API can be used to restore the data of such branch tasks.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartscheck:task:updateReportStatus

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

POST /v1/task/recover-data

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

No

String

Definition:

Language of the response.

Constraints:

N/A

Value range:

  • zh-cn: Chinese.

  • en-us: English.

Default value:

zh-cn
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

[items]

Yes

Array of ToRecoverTask objects

Definition:

Request body for restoring cold backup data.

Constraints:

N/A.
Table 3 ToRecoverTask

Parameter

Mandatory

Type

Description

taskId

Yes

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints:

N/A

Value range:

1 to 32 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Definition:

Response status.

Value range:

  • success: successful.

  • error: failed.

result

Array of RecoverResult objects

Definition:

Whether the task starts to restore data.
Table 5 RecoverResult

Parameter

Type

Description

taskId

String

Definition:

Task ID.

Value range:

1 to 32 characters.

allowRecover

Boolean

Definition:

Whether to start data restoration.

Value range:

  • true: The task has started.

  • false: Data cannot be restored.

reason

String

Definition:

Cause of the data recovery failure.

Value range:

N/A.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

Start to restore the scanning result data of the task whose ID is 897acf5exxx48a5013cd.

POST https://{endpoint}/v1/task/recover-data

[ {
  "taskId" : "897acf5exxx48a5013cd"
} ]

Example Responses

Status code: 200

Request succeeded.

{
  "status" : "success",
  "error" : null,
  "result" : [ {
    "taskId" : "897acf5exxx48a5013cd",
    "allowRecover" : true,
    "reason" : null
  } ]
}

Status code: 400

A request error occurred.

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

The permission is insufficient.

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

Request succeeded.

400

A request error occurred.

401

The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Code Issues