Consulta da lista de tarefas
Função
Esta API é usada para consultar a lista de tarefas.
URI
GET /v3/{project_id}/operation-logs
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto |
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
end_time |
Não |
String |
Hora de término de uma tarefa, no formato %YYYY-%mm-%ddT%HH:%MM:%SSZ. Por exemplo, 2018-02-01T12:00:00Z. |
enterprise_project_id |
Não |
String |
ID do projeto empresarial ou de all_granted_eps. all_granted_eps indica a consulta dos IDs de todos os projetos empresariais nos quais o usuário tem permissões. |
limit |
Não |
Integer |
Número de registros exibidos por página. O valor deve ser um número inteiro positivo. Mínimo: 1 |
offset |
Não |
Integer |
Deslocamento do valor. O valor deve ser um número inteiro positivo. Mínimo: 1 |
operation_type |
Não |
String |
Tipo da tarefa Valores de enumeração:
|
provider_id |
Não |
String |
ID do provedor de backup, que especifica se o objeto de backup é um servidor ou disco |
resource_id |
Não |
String |
ID do recurso de backup |
resource_name |
Não |
String |
Nome do recurso de backup |
start_time |
Não |
String |
Hora de início de uma tarefa, no formato %YYYY-%mm-%ddT%HH:%MM:%SSZ. Por exemplo, 2018-01-01T12:00:00Z. |
status |
Não |
String |
Status da tarefa Valores de enumeração:
|
vault_id |
Não |
String |
ID do cofre com o qual o recurso de destino está associado |
vault_name |
Não |
String |
Nome do cofre com o qual o recurso de destino está associado |
Parâmetros de solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Token de usuário. O token pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. |
Parâmetros de resposta
Código de status: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
operation_logs |
Array of OperationLog objects |
Lista de tarefas |
count |
Integer |
Número de tarefas |
limit |
Integer |
Número de registros exibidos em cada página Mínimo: 1 Máximo: 1000 Padrão: 1000 |
offset |
Integer |
Deslocamento onde a consulta começa Mínimo: 0 Padrão: 0 |
Parâmetro |
Tipo |
Descrição |
---|---|---|
checkpoint_id |
String |
ID do registro de backup |
created_at |
String |
Tempo de criação, por exemplo, 2020-02-23T01:00:32Z |
ended_at |
String |
Hora de término da tarefa, por exemplo, 2020-02-23T01:00:32Z |
error_info |
OpErrorInfo object |
Mensagem de erro da tarefa |
extra_info |
OpExtraInfo object |
Informações sobre a extensão da tarefa |
id |
String |
ID da tarefa |
operation_type |
String |
Tipo da tarefa Valores de enumeração:
|
policy_id |
String |
ID da política |
project_id |
String |
ID do projeto |
provider_id |
String |
ID do provedor de backup, que especifica se o objeto de backup é um servidor ou disco |
started_at |
String |
Hora de início da tarefa, por exemplo, 2020-02-23T01:00:32Z |
status |
String |
Status da tarefa Valores de enumeração:
|
updated_at |
String |
Tempo de modificação, por exemplo, 2020-02-23T01:00:32Z |
vault_id |
String |
ID do cofre com o qual o recurso de destino está associado |
vault_name |
String |
Nome do cofre com o qual o recurso de destino está associado |
Parâmetro |
Tipo |
Descrição |
---|---|---|
code |
String |
Para obter detalhes, consulte Códigos de erro. |
message |
String |
Mensagem de erro |
Parâmetro |
Tipo |
Descrição |
---|---|---|
backup |
OpExtendInfoBckup object |
Parâmetros estendidos de backup |
common |
OpExtendInfoCommon object |
Parâmetros comuns |
delete |
OpExtendInfoDelete object |
Parâmetros estendidos de exclusão |
sync |
OpExtendInfoSync object |
Parâmetros estendidos de sincronização |
remove_resources |
OpExtendInfoRemoveResources object |
Parâmetros estendidos de remover recursos de um cofre |
replication |
OpExtendInfoReplication object |
Parâmetros estendidos de replicação |
resource |
Resource object |
Informações de recurso |
restore |
OpExtendInfoRestore object |
Parâmetros estendidos de restauração |
vault_delete |
OpExtendInfoVaultDelete object |
Parâmetros estendidos de exclusão de um cofre |
Parâmetro |
Tipo |
Descrição |
---|---|---|
app_consistency_error_code |
String |
Código de erro retornado se o backup consistente com a aplicação falhar. Para obter detalhes, consulte Códigos de erro. |
app_consistency_error_message |
String |
Mensagem de erro retornada se o backup consistente com a aplicação falhar |
app_consistency_status |
String |
Status do backup consistente a aplicação, que pode ser definido como 0 (backup não consistente com a aplicação) ou 1 (backup consistente com a aplicação) Valores de enumeração:
|
backup_id |
String |
ID do backup |
backup_name |
String |
Nome do backup |
incremental |
String |
Se o backup incremental é usado Valores de enumeração:
|
Parâmetro |
Tipo |
Descrição |
---|---|---|
Progresso |
Integer |
Progresso da tarefa de consulta. O valor varia de 0 a 100. Mínimo: 0 Máximo: 100 |
request_id |
String |
ID da solicitação |
task_id |
String |
ID da tarefa de backup |
Parâmetro |
Tipo |
Descrição |
---|---|---|
backup_id |
String |
ID do backup |
backup_name |
String |
Nome do backup |
Parâmetro |
Tipo |
Descrição |
---|---|---|
sync_backup_num |
Integer |
Número de backups sincronizados |
delete_backup_num |
Integer |
Número de backups excluídos |
err_sync_backup_num |
Integer |
Número de backups que não conseguiram ser sincronizados |
Parâmetro |
Tipo |
Descrição |
---|---|---|
fail_count |
Integer |
Número de recursos que falhou ao ser excluídos |
total_count |
Integer |
Número de backups excluídos |
resources |
Array of Resource objects |
Informações de recurso |
Parâmetro |
Tipo |
Descrição |
---|---|---|
extra_info |
ResourceExtraInfo object |
Nome do cofre |
id |
String |
ID do tipo de recurso do cofre |
name |
String |
Nome do recurso a ser copiado. O valor consiste de 0 a 255 caracteres. Mínimo: 0 Máximo: 255 |
type |
String |
[Tipo do recurso a ser copiado, que pode ser OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo ou OS::Workspace::DesktopV2] (tag:hws,hws_hk) |
Parâmetro |
Tipo |
Descrição |
---|---|---|
destination_backup_id |
String |
ID do backup de destino |
destination_checkpoint_id |
String |
ID do ponto de restauração de destino |
destination_project_id |
String |
ID do projeto de destino |
destination_region |
String |
região de destino |
source_backup_id |
String |
ID de backup de origem |
source_checkpoint_id |
String |
ID do ponto de restauração de origem |
source_project_id |
String |
ID do projeto de origem |
source_region |
String |
Região de origem |
source_backup_name |
String |
Nome do backup de origem |
destination_backup_name |
String |
Nome do backup de destino |
Parâmetro |
Tipo |
Descrição |
---|---|---|
exclude_volumes |
Array of strings |
IDs dos discos dos quais não será feito backup. Este parâmetro é usado quando os servidores são adicionados a um cofre, que inclui todos os discos do servidor. Mas alguns discos não precisam ser copiados. Ou no caso de um servidor ter sido adicionado anteriormente e alguns discos neste servidor não precisarem ser copiados. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
backup_id |
String |
ID do backup |
backup_name |
String |
Nome do backup |
target_resource_id |
String |
ID do recurso a ser restaurado |
target_resource_name |
String |
Nome do recurso a ser restaurado |
Parâmetro |
Tipo |
Descrição |
---|---|---|
fail_count |
Integer |
Número de recursos que falham ao serem excluídos nesta tarefa |
total_count |
Integer |
Número de backups excluídos nesta tarefa |
Código de status: 404
Parâmetro |
Tipo |
Descrição |
---|---|---|
operation_logs |
Array of OperationLog objects |
Lista de tarefas |
count |
Integer |
Número de tarefas |
limit |
Integer |
Número de registros exibidos em cada página Mínimo: 1 Máximo: 1000 Padrão: 1000 |
offset |
Integer |
Deslocamento onde a consulta começa Mínimo: 0 Padrão: 0 |
Parâmetro |
Tipo |
Descrição |
---|---|---|
checkpoint_id |
String |
ID do registro de backup |
created_at |
String |
Tempo de criação, por exemplo, 2020-02-23T01:00:32Z |
ended_at |
String |
Hora de término da tarefa, por exemplo, 2020-02-23T01:00:32Z |
error_info |
OpErrorInfo object |
Mensagem de erro da tarefa |
extra_info |
OpExtraInfo object |
Informações sobre a extensão da tarefa |
id |
String |
ID da tarefa |
operation_type |
String |
Tipo da tarefa Valores de enumeração:
|
policy_id |
String |
ID da política |
project_id |
String |
ID do projeto |
provider_id |
String |
ID do provedor de backup, que especifica se o objeto de backup é um servidor ou disco |
started_at |
String |
Hora de início da tarefa, por exemplo, 2020-02-23T01:00:32Z |
status |
String |
Status da tarefa Valores de enumeração:
|
updated_at |
String |
Tempo de modificação, por exemplo, 2020-02-23T01:00:32Z |
vault_id |
String |
ID do cofre com o qual o recurso de destino está associado |
vault_name |
String |
Nome do cofre com o qual o recurso de destino está associado |
Parâmetro |
Tipo |
Descrição |
---|---|---|
code |
String |
Para obter detalhes, consulte Códigos de erro. |
message |
String |
Mensagem de erro |
Parâmetro |
Tipo |
Descrição |
---|---|---|
backup |
OpExtendInfoBckup object |
Parâmetros estendidos de backup |
common |
OpExtendInfoCommon object |
Parâmetros comuns |
delete |
OpExtendInfoDelete object |
Parâmetros estendidos de exclusão |
sync |
OpExtendInfoSync object |
Parâmetros estendidos de sincronização |
remove_resources |
OpExtendInfoRemoveResources object |
Parâmetros estendidos de remover recursos de um cofre |
replication |
OpExtendInfoReplication object |
Parâmetros estendidos de replicação |
resource |
Resource object |
Informações de recurso |
restore |
OpExtendInfoRestore object |
Parâmetros estendidos de restauração |
vault_delete |
OpExtendInfoVaultDelete object |
Parâmetros estendidos de exclusão de um cofre |
Parâmetro |
Tipo |
Descrição |
---|---|---|
app_consistency_error_code |
String |
Código de erro retornado se o backup consistente com a aplicação falhar. Para obter detalhes, consulte Códigos de erro. |
app_consistency_error_message |
String |
Mensagem de erro retornada se o backup consistente com a aplicação falhar |
app_consistency_status |
String |
Status do backup consistente a aplicação, que pode ser definido como 0 (backup não consistente com a aplicação) ou 1 (backup consistente com a aplicação) Valores de enumeração:
|
backup_id |
String |
ID do backup |
backup_name |
String |
Nome do backup |
incremental |
String |
Se o backup incremental é usado Valores de enumeração:
|
Parâmetro |
Tipo |
Descrição |
---|---|---|
progress |
Integer |
Progresso da tarefa de consulta. O valor varia de 0 a 100. Mínimo: 0 Máximo: 100 |
request_id |
String |
ID da solicitação |
task_id |
String |
ID da tarefa de backup |
Parâmetro |
Tipo |
Descrição |
---|---|---|
backup_id |
String |
ID do backup |
backup_name |
String |
Nome do backup |
Parâmetro |
Tipo |
Descrição |
---|---|---|
sync_backup_num |
Integer |
Número de backups sincronizados |
delete_backup_num |
Integer |
Número de backups excluídos |
err_sync_backup_num |
Integer |
Número de backups que não conseguiram ser sincronizados |
Parâmetro |
Tipo |
Descrição |
---|---|---|
fail_count |
Integer |
Número de recursos que falhou ao ser excluídos |
total_count |
Integer |
Número de backups excluídos |
resources |
Array of Resource objects |
Informações de recurso |
Parâmetro |
Tipo |
Descrição |
---|---|---|
extra_info |
ResourceExtraInfo object |
Nome do cofre |
id |
String |
ID do tipo de recurso do cofre |
name |
String |
Nome do recurso a ser copiado. O valor consiste de 0 a 255 caracteres. Mínimo: 0 Máximo: 255 |
type |
String |
[Tipo do recurso a ser copiado, que pode ser OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo ou OS::Workspace::DesktopV2] (tag:hws,hws_hk) |
Parâmetro |
Tipo |
Descrição |
---|---|---|
destination_backup_id |
String |
ID do backup de destino |
destination_checkpoint_id |
String |
ID do ponto de restauração de destino |
destination_project_id |
String |
ID do projeto de destino |
destination_region |
String |
Região de destino |
source_backup_id |
String |
ID de backup de origem |
source_checkpoint_id |
String |
ID do ponto de restauração de origem |
source_project_id |
String |
ID do projeto de origem |
source_region |
String |
Região de origem |
source_backup_name |
String |
Nome do backup de origem |
destination_backup_name |
String |
Nome do backup de destino |
Parâmetro |
Tipo |
Descrição |
---|---|---|
exclude_volumes |
Array of strings |
IDs dos discos dos quais não será feito backup. Este parâmetro é usado quando os servidores são adicionados a um cofre, que inclui todos os discos do servidor. Mas alguns discos não precisam ser copiados. Ou no caso de um servidor ter sido adicionado anteriormente e alguns discos neste servidor não precisarem ser copiados. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
backup_id |
String |
ID do backup |
backup_name |
String |
Nome do backup |
target_resource_id |
String |
ID do recurso a ser restaurado |
target_resource_name |
String |
Nome do recurso a ser restaurado |
Parâmetro |
Tipo |
Descrição |
---|---|---|
fail_count |
Integer |
Número de recursos que falham ao serem excluídos nesta tarefa |
total_count |
Integer |
Número de backups excluídos nesta tarefa |
Exemplo de solicitações
GET https://{endpoint}/v3/{project_id}/operation-logs
Exemplo de respostas
Código de status: 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 } ] }
Códigos de status
Código de status |
Descrição |
---|---|
200 |
OK |
404 |
Not Found |
Códigos de erro
Consulte Códigos de erro.