功能介绍
查询任务列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v3/{project_id}/operation-logs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
end_time |
否 |
String |
任务结束时间,格式为%YYYY-%mm-%ddT%HH:%MM:%SSZ,例如2018-02-01T12:00:00Z |
ent erp rise_project_id |
否 |
String |
企业项目id或all_granted_eps,all_granted_eps表示查询用户有权限的所有企业项目id |
limit |
否 |
Integer |
每页显示的条目数量,正整数 最小值:1 |
offset |
否 |
Integer |
偏移值,正整数 最小值:1 |
operation_type |
否 |
String |
任务类型 枚举值:
|
provider_id |
否 |
String |
备份提供商ID |
resource_id |
否 |
String |
该任务操作的资源ID |
resource_name |
否 |
String |
该任务操作的资源名称 |
start_time |
否 |
String |
任务开始时间,格式为%YYYY-%mm-%ddT%HH:%MM:%SSZ,例如2018-01-01T12:00:00Z |
status |
否 |
String |
任务状态 枚举值:
|
vault_id |
否 |
String |
存储库ID,该任务操作的资源所属绑定的存储库。 |
vault_name |
否 |
String |
存储库名称,该任务操作资源所绑定的存储库名称。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
operation_logs |
任务列表 |
|
count |
Integer |
任务个数 |
limit |
Integer |
每页显示的条目数量 最小值:1 最大值:1000 缺省值:1000 |
offset |
Integer |
偏移量,表示从此偏移量开始查询 最小值:0 缺省值:0 |
参数 |
参数类型 |
描述 |
---|---|---|
checkpoint_id |
String |
备份记录id |
created_at |
String |
创建时间,例如: "2020-02-23T01:00:32Z" |
ended_at |
String |
任务结束时间,例如: "2020-02-23T01:00:32Z" |
error_info |
任务错误信息 |
|
extra_info |
任务扩展信息 |
|
id |
String |
任务id |
operation_type |
String |
任务类型 枚举值:
|
policy_id |
String |
策略ID |
project_id |
String |
项目ID |
provider_id |
String |
备份提供商ID。用于区分备份对象。 |
started_at |
String |
任务开始时间,例如: "2020-02-23T01:00:32Z" |
status |
String |
任务状态 枚举值:
|
updated_at |
String |
修改时间,例如: "2020-02-23T01:00:32Z" |
vault_id |
String |
任务操作资源所属存储库ID |
vault_name |
String |
任务操作资源所属存储库名称 |
参数 |
参数类型 |
描述 |
---|---|---|
backup |
备份扩展参数 |
|
common |
公共参数 |
|
delete |
删除扩展参数 |
|
sync |
扩展同步信息 |
|
remove_resources |
移除Vault的资源 |
|
replication |
扩展复制信息 |
|
resource |
资源信息 |
|
restore |
扩展恢复信息 |
|
vault_delete |
删除vault |
参数 |
参数类型 |
描述 |
---|---|---|
app_consistency_error_code |
String |
应用一致性备份失败错误码。请参见错误码。 |
app_consistency_error_message |
String |
应用一致性备份错误信息 |
app_consistency_status |
String |
应用一致性备份状态;0:非应用一致性,1:应用一致性备份 枚举值:
|
backup_id |
String |
备份副本ID |
backup_name |
String |
备份名称 |
incremental |
String |
是否增备 枚举值:
|
参数 |
参数类型 |
描述 |
---|---|---|
progress |
Integer |
进度,取值为0-100 最小值:0 最大值:100 |
request_id |
String |
请求id |
task_id |
String |
备份任务id |
参数 |
参数类型 |
描述 |
---|---|---|
sync_backup_num |
Integer |
同步备份副本数 |
delete_backup_num |
Integer |
删除的备份副本数 |
err_sync_backup_num |
Integer |
同步失败备份副本数 |
参数 |
参数类型 |
描述 |
---|---|---|
fail_count |
Integer |
删除失败的资源数量 |
total_count |
Integer |
删除的备份数量 |
resources |
资源信息 |
参数 |
参数类型 |
描述 |
---|---|---|
extra_info |
资源附加信息 |
|
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 |
参数 |
参数类型 |
描述 |
---|---|---|
destination_backup_id |
String |
目标副本ID |
destination_checkpoint_id |
String |
目标还原点ID |
destination_project_id |
String |
目标project_id |
destination_region |
String |
目标区域 |
source_backup_id |
String |
源副本ID |
source_checkpoint_id |
String |
源还原点ID |
source_project_id |
String |
源project_id |
source_region |
String |
源区域 |
source_backup_name |
String |
源备份名称 |
destination_backup_name |
String |
目标备份名称 |
参数 |
参数类型 |
描述 |
---|---|---|
exclude_volumes |
Array of strings |
需要排除备份的卷id。仅在多盘备份特性中有效,排除不需要备份的磁盘。当虚拟机新绑定磁盘时,也能继续排除之前设置不用备份的卷。 |
参数 |
参数类型 |
描述 |
---|---|---|
backup_id |
String |
备份副本ID |
backup_name |
String |
备份名称 |
target_resource_id |
String |
恢复目标资源ID |
target_resource_name |
String |
恢复目标资源名称 |
参数 |
参数类型 |
描述 |
---|---|---|
fail_count |
Integer |
本次任务删除失败的资源数量 |
total_count |
Integer |
本次任务删除的备份总数 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
operation_logs |
任务列表 |
|
count |
Integer |
任务个数 |
limit |
Integer |
每页显示的条目数量 最小值:1 最大值:1000 缺省值:1000 |
offset |
Integer |
偏移量,表示从此偏移量开始查询 最小值:0 缺省值:0 |
参数 |
参数类型 |
描述 |
---|---|---|
checkpoint_id |
String |
备份记录id |
created_at |
String |
创建时间,例如: "2020-02-23T01:00:32Z" |
ended_at |
String |
任务结束时间,例如: "2020-02-23T01:00:32Z" |
error_info |
任务错误信息 |
|
extra_info |
任务扩展信息 |
|
id |
String |
任务id |
operation_type |
String |
任务类型 枚举值:
|
policy_id |
String |
策略ID |
project_id |
String |
项目ID |
provider_id |
String |
备份提供商ID。用于区分备份对象。 |
started_at |
String |
任务开始时间,例如: "2020-02-23T01:00:32Z" |
status |
String |
任务状态 枚举值:
|
updated_at |
String |
修改时间,例如: "2020-02-23T01:00:32Z" |
vault_id |
String |
任务操作资源所属存储库ID |
vault_name |
String |
任务操作资源所属存储库名称 |
参数 |
参数类型 |
描述 |
---|---|---|
backup |
备份扩展参数 |
|
common |
公共参数 |
|
delete |
删除扩展参数 |
|
sync |
扩展同步信息 |
|
remove_resources |
移除Vault的资源 |
|
replication |
扩展复制信息 |
|
resource |
资源信息 |
|
restore |
扩展恢复信息 |
|
vault_delete |
删除vault |
参数 |
参数类型 |
描述 |
---|---|---|
app_consistency_error_code |
String |
应用一致性备份失败错误码。请参见错误码。 |
app_consistency_error_message |
String |
应用一致性备份错误信息 |
app_consistency_status |
String |
应用一致性备份状态;0:非应用一致性,1:应用一致性备份 枚举值:
|
backup_id |
String |
备份副本ID |
backup_name |
String |
备份名称 |
incremental |
String |
是否增备 枚举值:
|
参数 |
参数类型 |
描述 |
---|---|---|
progress |
Integer |
进度,取值为0-100 最小值:0 最大值:100 |
request_id |
String |
请求id |
task_id |
String |
备份任务id |
参数 |
参数类型 |
描述 |
---|---|---|
sync_backup_num |
Integer |
同步备份副本数 |
delete_backup_num |
Integer |
删除的备份副本数 |
err_sync_backup_num |
Integer |
同步失败备份副本数 |
参数 |
参数类型 |
描述 |
---|---|---|
fail_count |
Integer |
删除失败的资源数量 |
total_count |
Integer |
删除的备份数量 |
resources |
资源信息 |
参数 |
参数类型 |
描述 |
---|---|---|
extra_info |
资源附加信息 |
|
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 |
参数 |
参数类型 |
描述 |
---|---|---|
destination_backup_id |
String |
目标副本ID |
destination_checkpoint_id |
String |
目标还原点ID |
destination_project_id |
String |
目标project_id |
destination_region |
String |
目标区域 |
source_backup_id |
String |
源副本ID |
source_checkpoint_id |
String |
源还原点ID |
source_project_id |
String |
源project_id |
source_region |
String |
源区域 |
source_backup_name |
String |
源备份名称 |
destination_backup_name |
String |
目标备份名称 |
参数 |
参数类型 |
描述 |
---|---|---|
exclude_volumes |
Array of strings |
需要排除备份的卷id。仅在多盘备份特性中有效,排除不需要备份的磁盘。当虚拟机新绑定磁盘时,也能继续排除之前设置不用备份的卷。 |
请求示例
GET https://{endpoint}/v3/{project_id}/operation-logs
响应示例
状态码: 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 } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
404 |
Not Found |
错误码
请参见错误码。