Help Center/ CodeArts Check/ API Reference/ APIs/ Code Issues/ Querying the Backup and Restoration Status
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Backup and Restoration Status

Function

This API is used to query the restoration progress and backup status of a branch task. If a branch task is not scanned for a long time, the scanning result will be backed up and then deleted.

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

GET /v2/backup/backup-infos

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

task_id

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

Request Parameters

Table 2 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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition:

Response status.

Value range:

  • success: successful.

  • error: failed.

result

Array of BackupInfo objects

Definition:

Task restoration progress and backup status.
Table 4 BackupInfo

Parameter

Type

Description

taskId

String

Definition:

Task ID.

Value range:

1 to 32 characters.

backupStatus

String

Definition:

Backup status of a task.

Value range:

  • SUCCESS: The backup is successful.

  • FAILED: The backup failed.

  • WAITTING: The backup is in progress.

backupTime

String

Definition:

Time when the task data is backed up. The value is a UTC time in the format of yyyy-MM-dd HH:mm:ss, for example, 2020-09-25 12:05:00.

Value range:

N/A.

recoverStatus

String

Definition:

Restoration status of a task.

Value range:

  • SUCCESS: The restoration is successful.

  • FAILED: The restoration fails.

  • WAITTING: The backup is in progress.

recoverTime

String

Definition:

Time when the task data is restored. The value is a UTC time in the format of yyyy-MM-dd HH:mm:ss, for example, 2020-09-25 12:05:00.

Value range:

N/A.

region

String

Definition:

Deprecated field.

Value range:

N/A.

progress

String

Definition

Progress of the data restoration task. For example, 100 indicates that the task is 100/ %completed.

Range

1–100

backupType

String

Definition:

Deprecated field.

Value range:

N/A.

cleanStatus

String

Definition:

Deprecated field.

Value range:

N/A.

Status code: 400

Table 5 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 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

Example Requests

Query the restoration progress and backup status of task ID 897acf5exxx48a5013cd.

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

Example Responses

Status code: 200

Request succeeded.

{
  "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"
  }
}

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