Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ TaurusDB/ Referencia de la API/ Las API (recomendadas)/ Gestión de copias de respaldo/ Consulta de copias de respaldo completas
Actualización más reciente 2025-03-21 GMT+08:00
Ver PDF
Compartir

Consulta de copias de respaldo completas

Función

Esta API se utiliza para consultar copias de respaldo de acuerdo con los criterios de búsqueda. Antes de invocar a esta API:

URI

GET /v3/{project_id}/backups

Tabla 1 Parámetros de URI

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

Explicación:

ID de proyecto de un tenant en una región.

Para obtener este valor, vea Obtención de un ID de proyecto.

Restricciones:

Ninguna

Rango de valor:

El valor puede contener 32 caracteres. Solo se permiten letras y dígitos.

Valor predeterminado:

Ninguno
Tabla 2 Parámetros de consulta

Parámetro

Obligatorio

Tipo

Descripción

instance_id

No

String

Explicación:

ID de instancia, que identifica de forma única una instancia.

Restricciones:

Ninguna

Rango de valor:

El valor puede contener 36 caracteres con el sufijo de in07. Solo se permiten letras y dígitos.

Valor predeterminado:

Ninguno

backup_id

No

String

Explicación:

ID de copia de respaldo, que identifica una copia de respaldo de forma única.

Restricciones:

Ninguna

Rango de valor:

El valor puede contener 36 caracteres con el sufijo de br07. Solo se permiten letras y dígitos.

Valor predeterminado:

Ninguno

backup_type

No

String

Explicación:

Tipo de copia de respaldo.

Restricciones:

Ninguna

Rango de valor:

  • auto: copia de respaldo completa automatizada
  • manual: copia de respaldo completa manual

Valor predeterminado:

Ninguno

offset

No

String

Explicación:

Desplazamiento de índice. La consulta comienza a partir de la siguiente pieza de datos indexada por este parámetro.

Restricciones:

El valor debe ser un número entero y no puede ser un número negativo.

Rango de valor:

≥0

Valor predeterminado:

0

limit

No

String

Explicación:

Número de registros a consultar.

Restricciones:

El valor debe ser un número entero y no puede ser un número negativo.

Rango de valor:

1–100

Valor predeterminado:

100

begin_time

No

String

Explicación:

Hora de inicio de la consulta en formato "aaaa-mm-ddThh:mm:ssZ".

T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100.

Restricciones:

Ninguna

Rango de valor:

La hora es anterior a la hora actual.

Valor predeterminado:

Ninguno

end_time

No

String

Explicación:

Consultar hora de fin en formato "aaaa-mm-ddThh:mm:ssZ".

T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100.

Restricciones:

Ninguna

Rango de valor:

La hora es anterior a la hora actual y posterior a la hora de inicio.

Valor predeterminado:

Ninguno

name

No

String

Explicación:

Nombre de copia de respaldo.

Restricciones:

Ninguna

Rango de valor:

El nombre debe comenzar con una letra y debe contener entre 4 y 64 caracteres. Solo se permiten letras (distinguen mayúsculas de minúsculas), dígitos, guiones (-) y guiones bajos (_).

Valor predeterminado:

Ninguno

instance_name

No

String

Explicación:

Nombre de instancia.

Restricciones:

Ninguna

Rango de valor:

El nombre debe comenzar con una letra y debe contener entre 4 y 64 caracteres. Solo se permiten letras (distinguen mayúsculas de minúsculas), dígitos, guiones (-) y guiones bajos (_).

Valor predeterminado:

Ninguno

Parámetros de solicitud

Tabla 3 Parámetros de encabezado de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

Explicación:

Token de usuario.

Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario.

El valor de X-Subject-Token en el encabezado de respuesta es el valor del token.

Restricciones:

Ninguna

Rango de valor:

Ninguna

Valor predeterminado:

Ninguna

X-Language

No

String

Explicación:

Tipo de idioma de solicitud.

Restricciones:

Ninguna

Rango de valor:

  • en-us
  • zh-cn

Valor predeterminado:

en-us

Parámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros de cuerpo de respuesta

Parámetro

Tipo

Descripción

backups

Array of backups objects

Explicación:

Información de copia de respaldo.

Rango de valor:

Ninguno

total_count

Long

Explicación:

Número total de archivos de copia de respaldo.

Rango de valor:

≥0
Tabla 5 backups

Parámetro

Tipo

Descripción

id

String

Explicación:

ID de copia de respaldo.

Rango de valor:

El valor puede contener 36 caracteres con el sufijo de br07. Solo se permiten letras y dígitos.

name

String

Explicación:

Nombre de copia de respaldo.

Rango de valor:

El nombre debe comenzar con una letra y debe contener entre 4 y 64 caracteres. Solo se permiten letras (distinguen mayúsculas de minúsculas), dígitos, guiones (-) y guiones bajos (_).

begin_time

String

Explicación:

Hora de inicio de copia de respaldo en el formato "aaaa-mm-ddThh:mm:ssZ".

T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100.

Rango de valor:

Ninguno

end_time

String

Explicación:

Hora de finalización de la copia de seguridad en el formato "aaaa-mm-ddThh:mm:ssZ".

T es el separador entre el calendario y la notación horaria del tiempo. Z indica el desplazamiento de la zona horaria. Por ejemplo, si el desplazamiento de la zona horaria es de una hora, el valor de Z es de +0100.

Rango de valor:

Ninguno

status

String

Explicación:

Estado de la copia de respaldo.

Rango de valor:

  • BUILDING: Copia de respaldo en curso
  • COMPLETED: Copia de respaldo completada
  • FAILED: Error de copia de respaldo
  • AVAILABLE: Copia de respaldo disponible

take_up_time

Integer

Explicación:

Duración de la copia de respaldo en minutos.

Rango de valor:

≥ 0

type

String

Explicación:

Tipo de copia de respaldo.

Rango de valor:

  • auto: copia de respaldo completa automatizada
  • manual: copia de respaldo completa manual

size

Long

Explicación:

Tamaño de copia de respaldo en MB.

Rango de valor:

≥0

datastore

MysqlDatastore object

Explicación:

Información de la base de datos.

instance_id

String

Explicación:

ID de instancia, que identifica de forma única una instancia.

Rango de valor:

El valor puede contener 36 caracteres con el sufijo de in07. Solo se permiten letras y dígitos.

instance_name

String

Explicación:

Nombre de instancia.

Rango de valor:

El nombre debe comenzar con una letra y debe contener entre 4 y 64 caracteres. Solo se permiten letras (distinguen mayúsculas de minúsculas), dígitos, guiones (-) y guiones bajos (_).

backup_level

String

Explicación:

Nivel de copia de respaldo. Este parámetro se devuelve cuando la función de copia de respaldo de nivel 1 está habilitada.

Rango de valor:

  • 0: Se está creando una copia de respaldo o se ha producido un error en la creación
  • 1: Copia de respaldo de nivel 1
  • 2: Copia de respaldo de nivel 2

description

String

Explicación:

Descripción del archivo de copia de respaldo.

Rango de valor:

Ninguno
Tabla 6 MysqlDatastore

Parámetro

Tipo

Descripción

type

String

Explicación:

Motor de base de datos.

Rango de valor:

gaussdb-mysql

version

String

Explicación:

Versión de base de datos.

Rango de valor:

8.0

Código de estado: 400

Tabla 7 Parámetros de cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 500

Tabla 8 Parámetros de cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Solicitud de ejemplo

Consulta de copias de respaldo automatizadas generadas del 6 de julio de 2020 al 16 de julio 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

Ejemplo de respuesta

Código de estado: 200

Operación exitosa.

{
  "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 estado

Para más detalles, véase Códigos de estado.

Código de error

Para más detalles, véase Códigos de error.