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/ TaurusDB/ Referência de API/ APIs (recomendadas)/ Gerenciamento de backup/ Consulta de backups completos
Atualizado em 2024-09-29 GMT+08:00
Ver PDF
Compartilhar

Consulta de backups completos

Função

Essa API é usada para consultar backups de acordo com critérios de pesquisa. Antes de chamar essa API:

URI

GET /v3/{project_id}/backups

Tabela 1 Parâmetros de URI

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto de um locatário numa região.

Para obter esse valor, consulte Obtenção de um ID de projeto.
Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

instance_id

Não

String

ID da instância.

backup_id

Não

String

ID de backup.

Para obter o valor, consulte o parâmetro de resposta backup retornado em Criação de um backup manual.

backup_type

Não

String

Tipo de backup.

Valor:

  • auto: backup completo automatizado
  • manual: backup completo manual

offset

Não

String

Deslocamento do índice. Se offset for definido como N, a consulta de recursos será iniciada a partir da parte N+1 dos dados. O valor é 0 por padrão, indicando que a consulta começa a partir da primeira parte dos dados. O valor não pode ser um número negativo.

limit

Não

String

Número de registros a serem consultados. O valor padrão é 100. O valor deve ser um número inteiro positivo. O valor mínimo é 1 e o valor máximo é 100.

begin_time

Não

String

Hora de início da consulta. O formato é "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.

end_time

Não

String

Hora de término da consulta. O formato é "aaaa-mm-ddThh:mm:ssZ" e a hora de término deve ser posterior à hora de início. T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.

name

Não

String

Nome do backup.

instance_name

Não

String

Nome da instância.

Parâmetros de solicitação

Tabela 3 Parâmetros de cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Token do usuário.

Se o corpo de resposta a seguir for retornado para chamar a API usada para obter um token de usuário, a solicitação será bem-sucedida.

Depois que a solicitação é processada, o valor de X-Subject-Token no cabeçalho da mensagem é o valor do token.

X-Language

Não

String

Tipo de linguagem da solicitação. O valor padrão é en-us.

Valor:

  • en-us
  • zh-cn

Parâmetros de resposta

Código de status: 200

Tabela 4 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

backups

Array of backups objects

Informações de backup.

total_count

Long

Número total de arquivos de backup.
Tabela 5 backups

Parâmetro

Tipo

Descrição

id

String

ID de backup.

name

String

Nome do backup.

begin_time

String

Hora de início do backup no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.

end_time

String

Hora de término do backup no formato "aaaa-mm-ddThh:mm:ssZ". T é o separador entre o calendário e a notação horária do tempo. Z indica o deslocamento do fuso horário. Por exemplo, no fuso horário de Pequim, o deslocamento do fuso horário é mostrado como +0800.

status

String

Status do backup.

Valor:

  • BUILDING: backup em andamento
  • COMPLETED: backup concluído
  • FAILED: falha no backup
  • AVAILABLE: backup disponível

take_up_time

Integer

Duração do backup em minutos.

type

String

Tipo de backup.

Valor:

  • auto: backup completo automatizado
  • manual: backup completo manual

size

Long

Tamanho do backup em MB.

datastore

MysqlDatastore object

Informações do banco de dados.

instance_id

String

ID da instância.

instance_name

String

Nome da instância.

backup_level

String

Nível de backup. Este parâmetro é retornado quando a função de backup de nível 1 está ativada.

Valor:

  • 0: backup sendo criado ou falha na criação
  • 1: backup de nível 1
  • 2: backup de nível 2

description

String

Descrição do arquivo de backup.
Tabela 6 MysqlDatastore

Parâmetro

Tipo

Descrição

type

String

Mecanismo de BD.

version

String

Versão de BD.

Para obter detalhes sobre as versões de BD suportadas, consulte Consulta de informações de versão sobre um mecanismo de BD.

Código de status: 400

Tabela 7 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Código de status: 500

Tabela 8 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

error_code

String

Código de erro.

error_msg

String

Mensagem de erro.

Exemplo de solicitação

Consulta de backups automatizados gerados de 6 de julho de 2020 a 16 de julho de 2020

GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800

Exemplo de resposta

Código de status: 200

Bem-sucedido.

{
  "backups" : [ {
    "id" : "1fe4feaab48f11e6654hfa163eba87e4b66u",
    "name" : "GaussDBforMySQL-gauss-e747-20200705185048266",
    "begin_time" : "2018-08-06T12:41:14+0800",
    "end_time" : "2018-08-06T12:45:14+0800",
    "take_up_time" : 2,
    "status" : "COMPLETED",
    "type" : "auto",
    "size" : 2803,
    "datastore" : {
      "type" : "GaussDB(for MySQL)",
      "version" : "8.0"
    },
    "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01",
    "instance_name" : "GaussDBforMySQL-gauss-e747",
    "backup_level" : "2"
  } ],
  "total_count" : 1
}

Código de status

Para mais detalhes, consulte Códigos de status.

Código de erro

Para mais detalhes, consulte Códigos de erro.

Tópico principal: Gerenciamento de backup