華為云計算 云知識 查詢?nèi)蝿?wù)列表ListOpLogs
查詢?nèi)蝿?wù)列表ListOpLogs

 

功能介紹

查詢?nèi)蝿?wù)列表

調(diào)試

您可以在API Explorer中調(diào)試該接口,支持自動認證鑒權(quán)。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。

URI

GET /v3/{project_id}/operation-logs

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID

表2 Query參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

end_time

String

任務(wù)結(jié)束時間,格式為%YYYY-%mm-%ddT%HH:%MM:%SSZ,例如2018-02-01T12:00:00Z

enterprise_project_id

String

企業(yè)項目id或all_granted_eps,all_granted_eps表示查詢用戶有權(quán)限的所有企業(yè)項目id

limit

Integer

每頁顯示的條目數(shù)量,正整數(shù)

最小值:1

offset

Integer

偏移值,正整數(shù)

最小值:1

operation_type

String

任務(wù)類型

枚舉值:

  • backup

  • copy

  • replication

  • delete

  • restore

  • vault_delete

  • remove_resource

  • sync

provider_id

String

備份提供商ID

resource_id

String

該任務(wù)操作的資源ID

resource_name

String

該任務(wù)操作的資源名稱

start_time

String

任務(wù)開始時間,格式為%YYYY-%mm-%ddT%HH:%MM:%SSZ,例如2018-01-01T12:00:00Z

status

String

任務(wù)狀態(tài)

枚舉值:

  • success

  • skipped

  • failed

  • running

  • timeout

  • waiting

vault_id

String

存儲庫ID,該任務(wù)操作的資源所屬綁定的存儲庫。

vault_name

String

存儲庫名稱,該任務(wù)操作資源所綁定的存儲庫名稱。

請求參數(shù)

表3 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。 通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值)。

響應(yīng)參數(shù)

狀態(tài)碼: 200

表4 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

operation_logs

Array of OperationLog objects

任務(wù)列表

count

Integer

任務(wù)個數(shù)

limit

Integer

每頁顯示的條目數(shù)量

最小值:1

最大值:1000

缺省值:1000

offset

Integer

偏移量,表示從此偏移量開始查詢

最小值:0

缺省值:0

表5 OperationLog

參數(shù)

參數(shù)類型

描述

checkpoint_id

String

備份記錄id

created_at

String

創(chuàng)建時間,例如: "2020-02-23T01:00:32Z"

ended_at

String

任務(wù)結(jié)束時間,例如: "2020-02-23T01:00:32Z"

error_info

OpErrorInfo object

任務(wù)錯誤信息

extra_info

OpExtraInfo object

任務(wù)擴展信息

id

String

任務(wù)id

operation_type

String

任務(wù)類型

枚舉值:

  • backup

  • copy

  • replication

  • restore

  • delete

  • sync

  • vault_delete

  • remove_resource

policy_id

String

策略ID

project_id

String

項目ID

provider_id

String

備份提供商ID。用于區(qū)分備份對象。

started_at

String

任務(wù)開始時間,例如: "2020-02-23T01:00:32Z"

status

String

任務(wù)狀態(tài)

枚舉值:

  • success

  • skipped

  • failed

  • running

  • timeout

  • waiting

updated_at

String

修改時間,例如: "2020-02-23T01:00:32Z"

vault_id

String

任務(wù)操作資源所屬存儲庫ID

vault_name

String

任務(wù)操作資源所屬存儲庫名稱

表6 OpErrorInfo

參數(shù)

參數(shù)類型

描述

code

String

請參見錯誤碼

message

String

錯誤信息

表7 OpExtraInfo

參數(shù)

參數(shù)類型

描述

backup

OpExtendInfoBckup object

備份擴展參數(shù)

common

OpExtendInfoCommon object

公共參數(shù)

delete

OpExtendInfoDelete object

刪除擴展參數(shù)

sync

OpExtendInfoSync object

擴展同步信息

remove_resources

OpExtendInfoRemoveResources object

移除Vault的資源

replication

OpExtendInfoReplication object

擴展復制信息

resource

Resource object

資源信息

restore

OpExtendInfoRestore object

擴展恢復信息

vault_delete

OpExtendInfoVaultDelete object

刪除vault

表8 OpExtendInfoBckup

參數(shù)

參數(shù)類型

描述

app_consistency_error_code

String

應(yīng)用一致性備份失敗錯誤碼。請參見錯誤碼。

app_consistency_error_message

String

應(yīng)用一致性備份錯誤信息

app_consistency_status

String

應(yīng)用一致性備份狀態(tài);0:非應(yīng)用一致性,1:應(yīng)用一致性備份

枚舉值:

  • 0

  • 1

backup_id

String

備份副本ID

backup_name

String

備份名稱

incremental

String

是否增備

枚舉值:

  • "true"

  • "false"

表9 OpExtendInfoCommon

參數(shù)

參數(shù)類型

描述

progress

Integer

進度,取值為0-100

最小值:0

最大值:100

request_id

String

請求id

task_id

String

備份任務(wù)id

表10 OpExtendInfoDelete

參數(shù)

參數(shù)類型

描述

backup_id

String

備份副本ID

backup_name

String

備份名稱

表11 OpExtendInfoSync

參數(shù)

參數(shù)類型

描述

sync_backup_num

Integer

同步備份副本數(shù)

delete_backup_num

Integer

刪除的備份副本數(shù)

err_sync_backup_num

Integer

同步失敗備份副本數(shù)

表12 OpExtendInfoRemoveResources

參數(shù)

參數(shù)類型

描述

fail_count

Integer

刪除失敗的資源數(shù)量

total_count

Integer

刪除的備份數(shù)量

resources

Array of Resource objects

資源信息

表13 Resource

參數(shù)

參數(shù)類型

描述

extra_info

ResourceExtraInfo object

資源附加信息

id

String

待備份資源id

name

String

待備份資源名稱,長度限制:0-255

最小長度:0

最大長度:255

type

String

待備份資源的類型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS:: Workspace ::DesktopV2

表14 OpExtendInfoReplication

參數(shù)

參數(shù)類型

描述

destination_backup_id

String

目標副本ID

destination_checkpoint_id

String

目標還原點ID

destination_project_id

String

目標project_id

destination_region

String

目標區(qū)域

source_backup_id

String

源副本ID

source_checkpoint_id

String

源還原點ID

source_project_id

String

源project_id

source_region

String

源區(qū)域

source_backup_name

String

源備份名稱

destination_backup_name

String

目標備份名稱

表15 ResourceExtraInfo

參數(shù)

參數(shù)類型

描述

exclude_volumes

Array of strings

需要排除備份的卷id。僅在多盤備份特性中有效,排除不需要備份的磁盤。當虛擬機新綁定磁盤時,也能繼續(xù)排除之前設(shè)置不用備份的卷。

表16 OpExtendInfoRestore

參數(shù)

參數(shù)類型

描述

backup_id

String

備份副本ID

backup_name

String

備份名稱

target_resource_id

String

恢復目標資源ID

target_resource_name

String

恢復目標資源名稱

表17 OpExtendInfoVaultDelete

參數(shù)

參數(shù)類型

描述

fail_count

Integer

本次任務(wù)刪除失敗的資源數(shù)量

total_count

Integer

本次任務(wù)刪除的備份總數(shù)

狀態(tài)碼: 404

表18 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

operation_logs

Array of OperationLog objects

任務(wù)列表

count

Integer

任務(wù)個數(shù)

limit

Integer

每頁顯示的條目數(shù)量

最小值:1

最大值:1000

缺省值:1000

offset

Integer

偏移量,表示從此偏移量開始查詢

最小值:0

缺省值:0

表19 OperationLog

參數(shù)

參數(shù)類型

描述

checkpoint_id

String

備份記錄id

created_at

String

創(chuàng)建時間,例如: "2020-02-23T01:00:32Z"

ended_at

String

任務(wù)結(jié)束時間,例如: "2020-02-23T01:00:32Z"

error_info

OpErrorInfo object

任務(wù)錯誤信息

extra_info

OpExtraInfo object

任務(wù)擴展信息

id

String

任務(wù)id

operation_type

String

任務(wù)類型

枚舉值:

  • backup

  • copy

  • replication

  • restore

  • delete

  • sync

  • vault_delete

  • remove_resource

policy_id

String

策略ID

project_id

String

項目ID

provider_id

String

備份提供商ID。用于區(qū)分備份對象。

started_at

String

任務(wù)開始時間,例如: "2020-02-23T01:00:32Z"

status

String

任務(wù)狀態(tài)

枚舉值:

  • success

  • skipped

  • failed

  • running

  • timeout

  • waiting

updated_at

String

修改時間,例如: "2020-02-23T01:00:32Z"

vault_id

String

任務(wù)操作資源所屬存儲庫ID

vault_name

String

任務(wù)操作資源所屬存儲庫名稱

表20 OpErrorInfo

參數(shù)

參數(shù)類型

描述

code

String

請參見錯誤碼

message

String

錯誤信息

表21 OpExtraInfo

參數(shù)

參數(shù)類型

描述

backup

OpExtendInfoBckup object

備份擴展參數(shù)

common

OpExtendInfoCommon object

公共參數(shù)

delete

OpExtendInfoDelete object

刪除擴展參數(shù)

sync

OpExtendInfoSync object

擴展同步信息

remove_resources

OpExtendInfoRemoveResources object

移除Vault的資源

replication

OpExtendInfoReplication object

擴展復制信息

resource

Resource object

資源信息

restore

OpExtendInfoRestore object

擴展恢復信息

vault_delete

OpExtendInfoVaultDelete object

刪除vault

表22 OpExtendInfoBckup

參數(shù)

參數(shù)類型

描述

app_consistency_error_code

String

應(yīng)用一致性備份失敗錯誤碼。請參見錯誤碼

app_consistency_error_message

String

應(yīng)用一致性備份錯誤信息

app_consistency_status

String

應(yīng)用一致性備份狀態(tài);0:非應(yīng)用一致性,1:應(yīng)用一致性備份

枚舉值:

  • 0

  • 1

backup_id

String

備份副本ID

backup_name

String

備份名稱

incremental

String

是否增備

枚舉值:

  • "true"

  • "false"

表23 OpExtendInfoCommon

參數(shù)

參數(shù)類型

描述

progress

Integer

進度,取值為0-100

最小值:0

最大值:100

request_id

String

請求id

task_id

String

備份任務(wù)id

表24 OpExtendInfoDelete

參數(shù)

參數(shù)類型

描述

backup_id

String

備份副本ID

backup_name

String

備份名稱

表25 OpExtendInfoSync

參數(shù)

參數(shù)類型

描述

sync_backup_num

Integer

同步備份副本數(shù)

delete_backup_num

Integer

刪除的備份副本數(shù)

err_sync_backup_num

Integer

同步失敗備份副本數(shù)

表26 OpExtendInfoRemoveResources

參數(shù)

參數(shù)類型

描述

fail_count

Integer

刪除失敗的資源數(shù)量

total_count

Integer

刪除的備份數(shù)量

resources

Array of Resource objects

資源信息

表27 Resource

參數(shù)

參數(shù)類型

描述

extra_info

ResourceExtraInfo object

資源附加信息

id

String

待備份資源id

name

String

待備份資源名稱,長度限制:0-255

最小長度:0

最大長度:255

type

String

待備份資源的類型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2

表28 OpExtendInfoReplication

參數(shù)

參數(shù)類型

描述

destination_backup_id

String

目標副本ID

destination_checkpoint_id

String

目標還原點ID

destination_project_id

String

目標project_id

destination_region

String

目標區(qū)域

source_backup_id

String

源副本ID

source_checkpoint_id

String

源還原點ID

source_project_id

String

源project_id

source_region

String

源區(qū)域

source_backup_name

String

源備份名稱

destination_backup_name

String

目標備份名稱

表29 ResourceExtraInfo

參數(shù)

參數(shù)類型

描述

exclude_volumes

Array of strings

需要排除備份的卷id。僅在多盤備份特性中有效,排除不需要備份的磁盤。當虛擬機新綁定磁盤時,也能繼續(xù)排除之前設(shè)置不用備份的卷。

表30 OpExtendInfoRestore

參數(shù)

參數(shù)類型

描述

backup_id

String

備份副本ID

backup_name

String

備份名稱

target_resource_id

String

恢復目標資源ID

target_resource_name

String

恢復目標資源名稱

表31 OpExtendInfoVaultDelete

參數(shù)

參數(shù)類型

描述

fail_count

Integer

本次任務(wù)刪除失敗的資源數(shù)量

total_count

Integer

本次任務(wù)刪除的備份總數(shù)

請求示例

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

響應(yīng)示例

狀態(tài)碼: 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.584418",
    "error_info" : {
      "message" : "",
      "code" : ""
    },
    "vault_id" : null,
    "started_at" : "2019-05-23T14:31:36.007230",
    "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.511155",
    "created_at" : "2019-05-23T14:31:36.039365",
    "operation_type" : "backup",
    "vault_name" : null,
    "project_id" : "04f1829c788037ac2fb8c01eb2b04b95",
    "policy_id" : null
  } ]
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

404

Not Found

錯誤碼

請參見錯誤碼。