Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Tasks/ Querying a Single Task
Updated on 2025-12-25 GMT+08:00
View PDF

Querying a Single Task

Function

This API is used to query a task by task ID.

URI

GET /v3/{project_id}/operation-logs/{operation_log_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

operation_log_id

Yes

String

Task ID

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

The token can be obtained by calling the IAM API used to obtain a user token. The user token is the value of X-Subject-Token in the response header.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

operation_log

OperationLog object

Task information
Table 4 OperationLog

Parameter

Type

Description

checkpoint_id

String

Backup record ID

created_at

String

Creation time, for example, 2020-02-23T01:00:32Z

ended_at

String

Task end time, for example, 2020-02-23T01:00:32Z

error_info

OpErrorInfo object

Task error message

extra_info

OpExtraInfo object

Task extension information

id

String

Task ID

operation_type

String

Task type

policy_id

String

Policy ID

project_id

String

Project ID

provider_id

String

Backup provider ID, which specifies whether the backup object is a server or disk

started_at

String

Task start time, for example, 2020-02-23T01:00:32Z

status

String

Task status

updated_at

String

Modification time, for example, 2020-02-23T01:00:32Z

vault_id

String

ID of the vault with which the target resource is associated

vault_name

String

Name of the vault with which the target resource is associated
Table 5 OpErrorInfo

Parameter

Type

Description

code

String

For details, see Error Codes.

message

String

Error message
Table 6 OpExtraInfo

Parameter

Type

Description

backup

OpExtendInfoBckup object

Extended parameters of backup

common

OpExtendInfoCommon object

Common parameters

delete

OpExtendInfoDelete object

Extended parameters of deletion

sync

OpExtendInfoSync object

Extended parameters of synchronization

remove_resources

OpExtendInfoRemoveResources object

Extended parameters of removing resources from a vault

replication

OpExtendInfoReplication object

Extended parameters of replication

resource

Resource object

Resource information

restore

OpExtendInfoRestore object

Extended parameters of restoration

vault_delete

OpExtendInfoVaultDelete object

Extended parameters of deleting a vault
Table 7 OpExtendInfoBckup

Parameter

Type

Description

app_consistency_error_code

String

Error code returned if application-consistent backup fails. For details, see Error Codes.

app_consistency_error_message

String

Error message returned if application-consistent backup fails

app_consistency_status

String

Application-consistent backup status. Default value: N/A

  • 0: Non-application consistent backup

  • 1: Application-consistent backup

backup_id

String

Backup ID. Default value: N/A

backup_name

String

Backup name. The value can contain a maximum of 64 characters, including digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-). Default value: N/A

incremental

String

Whether incremental backup is used
Table 8 OpExtendInfoCommon

Parameter

Type

Description

progress

Integer

Progress of the query task. The value ranges from 0 to 100.

request_id

String

Request ID

task_id

String

Backup task ID
Table 9 OpExtendInfoDelete

Parameter

Type

Description

backup_id

String

Backup ID. Default value: N/A

backup_name

String

Backup name. The value can contain a maximum of 64 characters, including digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-). Default value: N/A
Table 10 OpExtendInfoSync

Parameter

Type

Description

sync_backup_num

Integer

Number of synchronized backups

delete_backup_num

Integer

Number of deleted backups

err_sync_backup_num

Integer

Number of backups that failed to be synchronized
Table 11 OpExtendInfoRemoveResources

Parameter

Type

Description

fail_count

Integer

Number of resources that fail to be deleted

total_count

Integer

Number of deleted backups

resources

Array of Resource objects

Resource information
Table 12 Resource

Parameter

Type

Description

extra_info

ResourceExtraInfo object

Extra information of the resource

id

String

ID of the resource to be backed up. The resource must have been associated with the vault and can be backed up. Default value: N/A

name

String

Name of the resource to be backed up. The value can contain a maximum of 255 characters. Default value: N/A

type

String

Type of the resource to be backed up: OS::Nova::Server: ECS; OS::Cinder::Volume: EVS disks; OS::Ironic::BareMetalServer: Bare Metal Servers; OS::Sfs::Turbo: SFS Turbo file systems Default value: N/A
Table 13 OpExtendInfoReplication

Parameter

Type

Description

destination_backup_id

String

ID of the backup in the destination region. Default value: N/A

destination_checkpoint_id

String

Destination restore point ID

destination_project_id

String

ID of the project in the destination region. Default value: N/A

destination_region

String

Destination region. Default value: N/A

source_backup_id

String

ID of the backup at the source end. Default value: N/A

source_checkpoint_id

String

Source restore point ID

source_project_id

String

ID of the project in the source region. Default value: N/A

source_region

String

Source region. Default value: N/A

source_backup_name

String

Source backup name

destination_backup_name

String

Destination backup name
Table 14 ResourceExtraInfo

Parameter

Type

Description

exclude_volumes

Array of strings

ID of the volume that does not need to be backed up. This parameter is valid only for multi-disk backup. It specifies the disks that do not need to be backed up. When a disk is newly attached to a VM, the volume that does not need to be backed up can also be excluded. Default value: N/A

include_volumes

Array of ResourceExtraInfoIncludeVolumes objects

Volumes that need to be backed up. If this parameter is specified, only the specified volumes will be backed up. For example, if new volumes are added to a server after the server is associated with a vault, these new volumes will not be backed up. If this parameter is not specified, all volumes on the server will be backed up. This parameter takes effect only for disk-level backup. Default value: N/A
Table 15 ResourceExtraInfoIncludeVolumes

Parameter

Type

Description

id

String

Volume ID in UUID format. Default value: N/A

os_version

String

OS type. Default value: N/A
Table 16 OpExtendInfoRestore

Parameter

Type

Description

backup_id

String

ID of the backup replica. Default value: N/A

backup_name

String

Backup name. The value can contain a maximum of 64 characters, including digits, uppercase letters, lowercase letters, underscores (_), and hyphens (-). Default value: N/A

target_resource_id

String

Target resource ID in UUID format. Default value: N/A

target_resource_name

String

Name of the resource to be restored
Table 17 OpExtendInfoVaultDelete

Parameter

Type

Description

fail_count

Integer

Number of resources that fail to be deleted in this task

total_count

Integer

Number of backups deleted in this task

Status code: 404

Table 18 Response body parameters

Parameter

Type

Description

error_code

String

For details, see Error Codes.

error_msg

String

Error message

Example Requests

GET https://{endpoint}/v3/{project_id}/operation-logs/{operation_log_id}

Example Responses

Status code: 200

OK

{
  "operation_log" : {
    "status" : "success",
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "checkpoint_id" : "b432511f-d889-428f-8b0e-5f47c524c6b6",
    "updated_at" : "2019-05-23T14:35:23.584+00:00",
    "error_info" : {
      "message" : "",
      "code" : ""
    },
    "started_at" : "2019-05-23T14:31:36.007+00:00",
    "id" : "4827f2da-b008-4507-ab7d-42d0df5ed912",
    "extra_info" : {
      "resource" : {
        "type" : "OS::Nova::Server",
        "id" : "1dab32fa-ebf2-415a-ab0b-eabe6353bc86",
        "name" : "ECS-0001"
      },
      "backup" : {
        "backup_name" : "manualbk_1234",
        "backup_id" : "0e5d0ef6-7f0a-4890-b98c-cb12490e31c1"
      },
      "common" : {
        "progress" : 100,
        "request_id" : "req-cdb98cc4-e87b-4f40-9b4a-57ec036620bc"
      }
    },
    "ended_at" : "2019-05-23T14:35:23.511+00:00",
    "created_at" : "2019-05-23T14:31:36.039+00:00",
    "operation_type" : "backup",
    "project_id" : "04f1829c788037ac2fb8c01eb2b04b95"
  }
}

Status code: 404

The task ID does not exist.

{
  "error_code" : "BackupService.6500",
  "error_msg" : "Operation log does not exist."
}

Status Codes

Status Code

Description

200

OK

404

The task ID does not exist.

Error Codes

See Error Codes.

Parent topic: Tasks