Help Center/ Host Security Service/ API Reference/ API Description/ Ransomware Prevention/ Querying the Backup and Restoration Task List
Updated on 2026-04-03 GMT+08:00

Querying the Backup and Restoration Task List

Function

This API is used to query the list of backup and restoration tasks.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/ransomware/backup/operation-logs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

status

No

String

Restoration status. The options are as follows:

  • success

  • skipped

  • failed

  • running

  • timeout:

  • waiting

resource_name

No

String

Server name

offset

Yes

Integer

Start time of the query.

limit

Yes

Integer

Number of records displayed on each page.

last_days

No

Integer

Query time range

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_num

Integer

Total

data_list

Array of OperationLogInfo objects

list

Table 5 OperationLogInfo

Parameter

Type

Description

host_id

String

Server ID

host_name

String

Server name

backup_name

String

Backup name

process

Integer

Restoration progress, in percentage.

status

String

Restoration status. The options are as follows:

  • success:

  • skipped

  • failed

  • running

  • timeout:

  • waiting

started_at

String

Start time of a task.

ended_at

String

Task end time.

error_info

ErrorInfo object

Failure information

Table 6 ErrorInfo

Parameter

Type

Description

code

String

Error code

message

String

Error message

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "c882e0-c4c1-4e89-b99a-f632",
    "host_name" : "ecs-test",
    "backup_name" : "autobk_9",
    "process" : 100,
    "status" : "success",
    "started_at" : "2025-03-06T05:26:18Z",
    "error_info" : {
      "code" : "",
      "message" : ""
    }
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.