Updated on 2024-05-11 GMT+08:00

Querying the Task List

Function

Querying the Task List

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v3/{project_id}/operation-logs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

end_time

No

String

End time of a task, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example, 2018-02-01T12:00:00Z.

enterprise_project_id

No

String

Enterprise project ID or all_granted_eps. all_granted_eps indicates querying the IDs of all enterprise projects on which the user has permissions.

limit

No

Integer

Number of records displayed per page. The value must be a positive integer.

Minimum: 1

offset

No

Integer

Offset value. The value must be a positive integer.

Minimum: 1

operation_type

No

String

Task type

Enumeration values:

  • backup

  • copy

  • replication

  • delete

  • restore

  • vault_delete

  • remove_resource

  • sync

provider_id

No

String

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

resource_id

No

String

Backup resource ID

resource_name

No

String

Backup resource name

start_time

No

String

Start time of a task, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example, 2018-01-01T12:00:00Z.

status

No

String

Task status

Enumeration values:

  • success

  • skipped

  • failed

  • running

  • timeout

  • waiting

vault_id

No

String

ID of the vault with which the target resource is associated

vault_name

No

String

Name of the vault with which the target resource is associated

Request Parameters

Table 3 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 value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

operation_logs

Array of OperationLog objects

Task list

count

Integer

Number of tasks

limit

Integer

Number of records displayed on each page

Minimum: 1

Maximum: 1000

Default: 1000

offset

Integer

Offset where the query starts

Minimum: 0

Default: 0

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

Enumeration values:

  • backup

  • copy

  • replication

  • restore

  • delete

  • sync

  • vault_delete

  • remove_resource

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

Enumeration values:

  • success

  • skipped

  • failed

  • running

  • timeout

  • waiting

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 6 OpErrorInfo

Parameter

Type

Description

code

String

For details, see Error Codes.

message

String

Error message

Table 7 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 8 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, which can be set to 0 (non-application-consistent backup) or 1 (application-consistent backup)

Enumeration values:

  • 0

  • 1

backup_id

String

Backup ID

backup_name

String

Backup name

incremental

String

Whether incremental backup is used

Enumeration values:

  • "true"

  • "false"

Table 9 OpExtendInfoCommon

Parameter

Type

Description

progress

Integer

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

Minimum: 0

Maximum: 100

request_id

String

Request ID

task_id

String

Backup task ID

Table 10 OpExtendInfoDelete

Parameter

Type

Description

backup_id

String

Backup ID

backup_name

String

Backup name

Table 11 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 12 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 13 Resource

Parameter

Type

Description

extra_info

ResourceExtraInfo object

Extra information of the resource

id

String

ID of the resource to be backed up

name

String

Name of the resource to be backed up. The value consists of 0 to 255 characters.

Minimum: 0

Maximum: 255

type

String

Type of the resource to be backed up, which can be OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, or OS::Workspace::DesktopV2

Table 14 OpExtendInfoReplication

Parameter

Type

Description

destination_backup_id

String

Destination backup ID

destination_checkpoint_id

String

Destination restore point ID

destination_project_id

String

Destination project ID

destination_region

String

Destination region

source_backup_id

String

Source backup ID

source_checkpoint_id

String

Source restore point ID

source_project_id

String

Source project ID

source_region

String

Source region

source_backup_name

String

Source backup name

destination_backup_name

String

Destination backup name

Table 15 ResourceExtraInfo

Parameter

Type

Description

exclude_volumes

Array of strings

IDs of the disks that will not be backed up. This parameter is used when servers are added to a vault, which include all server disks. But some disks do not need to be backed up. Or in case that a server was previously added and some disks on this server do not need to be backed up.

Table 16 OpExtendInfoRestore

Parameter

Type

Description

backup_id

String

Backup ID

backup_name

String

Backup name

target_resource_id

String

ID of the resource to be restored

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

operation_logs

Array of OperationLog objects

Task list

count

Integer

Number of tasks

limit

Integer

Number of records displayed on each page

Minimum: 1

Maximum: 1000

Default: 1000

offset

Integer

Offset where the query starts

Minimum: 0

Default: 0

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

Enumeration values:

  • backup

  • copy

  • replication

  • restore

  • delete

  • sync

  • vault_delete

  • remove_resource

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

Enumeration values:

  • success

  • skipped

  • failed

  • running

  • timeout

  • waiting

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 20 OpErrorInfo

Parameter

Type

Description

code

String

For details, see Error Codes.

message

String

Error message

Table 21 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 22 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, which can be set to 0 (non-application-consistent backup) or 1 (application-consistent backup)

Enumeration values:

  • 0

  • 1

backup_id

String

Backup ID

backup_name

String

Backup name

incremental

String

Whether incremental backup is used

Enumeration values:

  • "true"

  • "false"

Table 23 OpExtendInfoCommon

Parameter

Type

Description

progress

Integer

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

Minimum: 0

Maximum: 100

request_id

String

Request ID

task_id

String

Backup task ID

Table 24 OpExtendInfoDelete

Parameter

Type

Description

backup_id

String

Backup ID

backup_name

String

Backup name

Table 25 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 26 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 27 Resource

Parameter

Type

Description

extra_info

ResourceExtraInfo object

Extra information of the resource

id

String

ID of the resource to be backed up

name

String

Name of the resource to be backed up. The value consists of 0 to 255 characters.

Minimum: 0

Maximum: 255

type

String

Type of the resource to be backed up, which can be OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, or OS::Workspace::DesktopV2

Table 28 OpExtendInfoReplication

Parameter

Type

Description

destination_backup_id

String

Destination backup ID

destination_checkpoint_id

String

Destination restore point ID

destination_project_id

String

Destination project ID

destination_region

String

Destination region

source_backup_id

String

Source backup ID

source_checkpoint_id

String

Source restore point ID

source_project_id

String

Source project ID

source_region

String

Source region

source_backup_name

String

Source backup name

destination_backup_name

String

Destination backup name

Table 29 ResourceExtraInfo

Parameter

Type

Description

exclude_volumes

Array of strings

IDs of the disks that will not be backed up. This parameter is used when servers are added to a vault, which include all server disks. But some disks do not need to be backed up. Or in case that a server was previously added and some disks on this server do not need to be backed up.

Table 30 OpExtendInfoRestore

Parameter

Type

Description

backup_id

String

Backup ID

backup_name

String

Backup name

target_resource_id

String

ID of the resource to be restored

target_resource_name

String

Name of the resource to be restored

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

Example Requests

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

Example Responses

Status code: 200

OK

{
  "count" : 1,
  "operation_logs" : [ {
    "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_backup",
        "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 Codes

Status Code

Description

200

OK

404

Not Found

Error Codes

See Error Codes.