Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda/ Cloud Backup and Recovery/ Referência de API/ APIs do CBR/ Backups/ Consulta de todos os backups

Atualizado em 2023-04-26 GMT+08:00

Ver PDF

Consulta de todos os backups

Função

Esta API é usada para consultar todos os backups.

URI

GET /v3/{project_id}/backups

**Tabela 1** Parâmetros de caminho
Parâmetro	Obrigatório	Tipo	Descrição
project_id	Sim	String	ID do projeto

**Tabela 2** Parâmetros de consulta
Parâmetro	Obrigatório	Tipo	Descrição
checkpoint_id	Não	String	ID do ponto de restauração
dec	Não	Boolean	Nuvem dedicada
end_time	Não	String	Hora em que o backup termina, 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 all_granted_eps. all_granted_eps indica a consulta dos IDs de todos os projetos empresariais nos quais o usuário tem permissões.
image_type	Não	String	Tipo de backup, que pode ser backup ou replication.
limit	Não	Integer	Número de registros exibidos por página. O valor deve ser um número inteiro positivo.
marker	Não	String	ID do último registro exibido na página anterior
member_status	Não	String	Status do compartilhamento de backup Valores de enumeração: pending accepted rejected
name	Não	String	Nome do backup
offset	Não	Integer	Deslocamento do valor. O valor deve ser um número inteiro positivo.
own_type	Não	String	Tipo de propriedade de um backup. Backups de private são consultados por padrão. Padrão: private Valores de enumeração: all_granted private shared
parent_id	Não	String	ID de backup pai
resource_az	Não	String	A filtragem baseada em AZ é suportada.
resource_id	Não	String	ID do recurso
resource_name	Não	String	Nome do recurso
resource_type	Não	String	Tipo de recurso, que pode ser OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo ou OS::Workspace::DesktopV2
show_replication	Não	Boolean	Se mostrar registros de replicação. Padrão: false
sort	Não	String	Um grupo de propriedades separadas por vírgulas (,) e direções de classificação. O formato do valor é [:],[:], onde o valor da direção é asc (em ordem crescente) ou desc (em ordem decrescente). Se a direção do parâmetro não for especificada, a direção de classificação padrão é desc. O valor de classificação pode conter no máximo 255 caracteres. O intervalo de valores da chave é o seguinte: [created_at, updated_at, name, status, protected_at, id]
start_time	Não	String	Hora em que o backup é iniciado, no formato %YYYY-%mm-%ddT%HH:%MM:%SSZ. Por exemplo, 2018-02-01T12:00:00Z.
status	Não	String	Status. Quando a API é chamada, vários estados podem ser transferidos para filtragem, por exemplo, status=available&status=error. Valores de enumeração: available protecting deleting restoring error waiting_protect waiting_delete waiting_restore
used_percent	Não	String	Os backups são filtrados com base na capacidade do cofre ocupada. O valor varia de 1 a 100. Por exemplo, se used_percent for definido como 80, todos os backups que ocuparam 80% ou mais da capacidade do compartimento serão exibidos.
vault_id	Não	String	ID do cofre

Parâmetros de solicitação

**Tabela 3** Parâmetros do cabeçalho 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

**Tabela 4** Parâmetros de corpo de resposta
Parâmetro	Tipo	Descrição
backups	Array of BackupResp objects	Lista de backup
count	Integer	Número de backups
offset	Integer	Deslocamento onde a consulta começa Mínimo: 0 Padrão: 0
limit	Integer	Número de registros exibidos em cada página Mínimo: 1 Máximo: 1000 Padrão: 1000

**Tabela 5** BackupResp
Parâmetro	Tipo	Descrição
checkpoint_id	String	ID do ponto de restauração
created_at	String	Tempo de criação, por exemplo, 2020-02-05T10:38:34.209782
description	String	Descrição do backup
expired_at	String	Tempo de expiração, por exemplo, 2020-02-05T10:38:34.209782
extend_info	BackupExtendInfo object	Informação ampliada
id	String	ID do backup
image_type	String	Tipo de backup, que pode ser backup ou replication.
name	String	Nome do backup
parent_id	String	ID de backup pai
project_id	String	ID do projeto
protected_at	String	Tempo de backup
resource_az	String	Zona de disponibilidade de recursos
resource_id	String	ID do recurso
resource_name	String	Nome do recurso
resource_size	Integer	Tamanho do recurso, em GB
resource_type	String	Tipo de recurso, que pode ser OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo ou OS::Workspace::DesktopV2
status	String	Estado do backup. Valores de enumeração: available protecting deleting restoring error waiting_protect waiting_delete waiting_restore
updated_at	String	Tempo de atualização, por exemplo, 2020-02-05T10:38:34.209782
vault_id	String	ID do cofre
replication_records	Array of ReplicationRecordGet objects	Registro de replicação
enterprise_project_id	String	ID do projeto empresarial. O valor padrão é 0.
provider_id	String	ID do provedor de backup, que é usado para distinguir objetos de backup. O valor pode ser o seguinte: 0daac4c5-6707-4851-97ba-169e36266b66 indica que os objetos de backup são servidores em nuvem; d1603440-187d-4516-af25-121250c7cc97 indica que os objetos de backup são discos em nuvem; 3f3c3220-245c-4805-b811-758870015881 indica que os objetos de backup são sistemas de arquivos do SFS Turbo; a13639de-00be-4e94-af30-26912d75e4a2 indica que os objetos de backup são backups de VMware em nuvem híbrida.
children	Array of BackupResp objects	Lista de backup

**Tabela 6** BackupExtendInfo
Parâmetro	Tipo	Descrição
auto_trigger	Boolean	Se o backup é gerado automaticamente
bootable	Boolean	Se o backup é um backup em disco do sistema
incremental	Boolean	Se o backup é um backup incremental
snapshot_id	String	ID do snapshot do backup em disco
support_lld	Boolean	Se permitir lazyloading para restauração rápida
supported_restore_mode	String	Modo de restauração. Os valores possíveis são na, snapshot e backup. snapshot indica que o backup pode ser usado para criar uma imagem de servidor completo. backup indica que os dados são restaurados a partir de backups em discos EVS do servidor. na indica que o backup só pode ser usado para criar novos recursos, mas não pode ser usado para restauração. Padrão: na Valores de enumeração: na backup snapshot
os_images_data	Array of ImageData objects	Lista de IDs de imagens criadas usando backups
contain_system_disk	Boolean	Se os dados de backup da máquina virtual contêm dados de disco do sistema
encrypted	Boolean	Se o backup é criptografado
system_disk	Boolean	Se o disco é um disco do sistema

**Tabela 7** ImageData
Parâmetro	Tipo	Descrição
image_id	String	ID da imagem

**Tabela 8** ReplicationRecordGet
Parâmetro	Tipo	Descrição
created_at	String	Hora de início da replicação
destination_backup_id	String	ID do backup de destino usado para replicação
destination_checkpoint_id	String	ID de registro do backup de destino usado para replicação
destination_project_id	String	ID do projeto de replicação de destino
destination_region	String	Região de replicação de destino
destination_vault_id	String	ID do cofre de destino
extra_info	ReplicationRecordsExtraInfo object	Informações adicionais sobre a replicação
id	String	ID do registro de replicação
source_backup_id	String	ID do backup de origem usado para replicação
source_checkpoint_id	String	ID do registro de backup de origem usado para replicação
source_project_id	String	ID do projeto de origem de replicação
source_region	String	Região de origem de replicação
status	String	Estado da replicação Valores de enumeração: replicating success fail skip waiting_replicate
vault_id	String	ID do cofre onde reside o backup

**Tabela 9** ReplicationRecordsExtraInfo
Parâmetro	Tipo	Descrição
progress	Integer	Progresso da replicação
fail_code	String	Código de erro. Este campo estará vazio se a operação for bem-sucedida.
fail_reason	String	Causa do erro
auto_trigger	Boolean	Se a replicação é agendada automaticamente
destinatio_vault_id	String	ID do cofre de destino

Exemplo de solicitações

GET  https://{endpoint}/v3/{project_id}/backups

Exemplo de respostas

Código de status: 200

{
  "count" : 2,
  "backups" : [ {
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "checkpoint_id" : "1fced58b-2a31-4851-bcbb-96216f83ce99",
    "updated_at" : "2020-02-21T07:07:25.113761",
    "vault_id" : "cca85ea5-00a4-418d-9222-bd83985bc515",
    "id" : "b1c4afd9-e7a6-4888-9010-c2bac3aa7910",
    "resource_az" : "br-iaas-odin1a",
    "image_type" : "backup",
    "resource_id" : "1a503932-ee8f-4dd5-8248-8dfb57e584c5",
    "resource_size" : 40,
    "children" : [ ],
    "extend_info" : {
      "auto_trigger" : true,
      "supported_restore_mode" : "backup",
      "contain_system_disk" : true,
      "support_lld" : true,
      "system_disk" : false
    },
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "status" : "available",
    "resource_name" : "test001-02",
    "description" : "",
    "expired_at" : "2020-05-21T07:00:54.060493",
    "name" : "autobk_b629",
    "created_at" : "2020-02-21T07:00:54.065135",
    "resource_type" : "OS::Nova::Server"
  }, {
    "provider_id" : "d1603440-187d-4516-af25-121250c7cc97",
    "checkpoint_id" : "f64c351f-769f-4c04-8806-fd90a59e9b12",
    "updated_at" : "2020-02-21T07:09:37.767084",
    "vault_id" : "79bd9daa-884f-4f84-b8fe-235d58cd927d",
    "id" : "5606aab5-2dc2-4498-8144-dc848d099af5",
    "resource_az" : "br-iaas-odin1a",
    "image_type" : "backup",
    "resource_id" : "54f7ccbc-072f-4ec5-a7b7-b24dabdb4539",
    "resource_size" : 40,
    "children" : [ ],
    "extend_info" : {
      "auto_trigger" : true,
      "snapshot_id" : "e3def9a8-e4b4-4c12-b132-f4ba8ce9a34f",
      "bootable" : true,
      "support_lld" : true,
      "encrypted" : false,
      "system_disk" : false
    },
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "status" : "available",
    "resource_name" : "qsy_000",
    "description" : "",
    "expired_at" : "2020-03-22T07:00:34.877896",
    "name" : "autobk_6809",
    "created_at" : "2020-02-21T07:00:34.882174",
    "resource_type" : "OS::Cinder::Volume"
  } ]
}