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 2025-05-23 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

Explicação:

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

Para obter esse valor, consulte Obtenção de um ID de projeto.

Restrições:

Nenhuma

Intervalo de valores:

O valor pode conter 32 caracteres. Apenas letras e dígitos são permitidos.

Valor padrão:

Nenhum

Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

instance_id

Não

String

Explicação:

ID da instância, que identifica exclusivamente uma instância.

Restrições:

Nenhuma

Intervalo de valores:

O valor pode conter 36 caracteres com um sufixo de in07. Apenas letras e dígitos são permitidos.

Valor padrão:

Nenhum

backup_id

Não

String

Explicação:

ID de backup, que identifica exclusivamente um backup.

Restrições:

Nenhuma

Intervalo de valores:

O valor pode conter 36 caracteres com um sufixo de br07. Apenas letras e dígitos são permitidos.

Valor padrão:

Nenhum

backup_type

Não

String

Explicação:

Tipo de backup.

Restrições:

Nenhuma

Intervalo de valores:

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

Valor padrão:

Nenhum

offset

Não

String

Explicação:

Deslocamento do índice. A consulta começa a partir da próxima parte dos dados indexados por este parâmetro.

Restrições:

O valor deve ser um número inteiro e não pode ser um número negativo.

Intervalo de valores:

≥0

Valor padrão:

0

limit

Não

String

Explicação:

Número de registros a serem consultados.

Restrições:

O valor deve ser um número inteiro e não pode ser um número negativo.

Intervalo de valores:

1–100

Valor padrão:

100

begin_time

Não

String

Explicação:

Consulte a hora de início 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, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100.

Restrições:

Nenhuma

Intervalo de valores:

A hora é anterior à hora atual.

Valor padrão:

Nenhum

end_time

Não

String

Explicação:

Hora de término de consulta 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, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100.

Restrições:

Nenhuma

Intervalo de valores:

A hora é anterior à hora atual e posterior à hora de início.

Valor padrão:

Nenhum

name

Não

String

Explicação:

Nome do backup.

Restrições:

Nenhuma

Intervalo de valores:

O nome deve começar com uma letra e consistir de 4 a 64 caracteres. Somente letras (diferenciando maiúsculas de minúsculas), dígitos, hifens (-) e sublinhados (_) são permitidos.

Valor padrão:

Nenhum

instance_name

Não

String

Explicação:

Nome da instância.

Restrições:

Nenhuma

Intervalo de valores:

O nome deve começar com uma letra e consistir de 4 a 64 caracteres. Somente letras (diferenciando maiúsculas de minúsculas), dígitos, hifens (-) e sublinhados (_) são permitidos.

Valor padrão:

Nenhum

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

Explicação:

Token do usuário.

Ele 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 valor do token.

Restrições:

Nenhuma

Intervalo de valores:

Nenhum

Valor padrão:

Nenhum

X-Language

Não

String

Explicação:

Tipo de linguagem da solicitação.

Restrições:

Nenhuma

Intervalo de valores:

  • en-us
  • zh-cn

Valor padrão:

en-us

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

Explicação:

Informações de backup.

Intervalo de valores:

Nenhum

total_count

Long

Explicação:

Número total de arquivos de backup.

Intervalo de valores:

≥0

Tabela 5 backups

Parâmetro

Tipo

Descrição

id

String

Explicação:

ID de backup.

Intervalo de valores:

O valor pode conter 36 caracteres com um sufixo de br07. Apenas letras e dígitos são permitidos.

name

String

Explicação:

Nome do backup.

Intervalo de valores:

O nome deve começar com uma letra e consistir de 4 a 64 caracteres. Somente letras (diferenciando maiúsculas de minúsculas), dígitos, hifens (-) e sublinhados (_) são permitidos.

begin_time

String

Explicação:

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, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100.

Intervalo de valores:

Nenhum

end_time

String

Explicação:

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, se o deslocamento de fuso horário for de uma hora, o valor de Z será +0100.

Intervalo de valores:

Nenhum

status

String

Explicação:

Status do backup.

Intervalo de valores:

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

take_up_time

Integer

Explicação:

Duração do backup em minutos.

Intervalo de valores:

≥ 0

type

String

Explicação:

Tipo de backup.

Intervalo de valores:

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

size

Long

Explicação:

Tamanho do backup em MB.

Intervalo de valores:

≥0

datastore

MysqlDatastore object

Explicação:

Informações do banco de dados.

instance_id

String

Explicação:

ID da instância, que identifica exclusivamente uma instância.

Intervalo de valores:

O valor pode conter 36 caracteres com um sufixo de in07. Apenas letras e dígitos são permitidos.

instance_name

String

Explicação:

Nome da instância.

Intervalo de valores:

O nome deve começar com uma letra e consistir de 4 a 64 caracteres. Somente letras (diferenciando maiúsculas de minúsculas), dígitos, hifens (-) e sublinhados (_) são permitidos.

backup_level

String

Explicação:

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

Intervalo de valores:

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

description

String

Explicação:

Descrição do arquivo de backup.

Intervalo de valores:

Nenhum

Tabela 6 MysqlDatastore

Parâmetro

Tipo

Descrição

type

String

Explicação:

Mecanismo de BD.

Intervalo de valores:

gaussdb-mysql

version

String

Explicação:

Versão de BD.

Intervalo de valores:

8.0

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" : "TaurusDB-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" : "TaurusDB-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