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/ Cloud Backup and Recovery/ Referencia de la API/ APIs de CBR/ Almacenes/ Consulta de la lista de almacén

Actualización más reciente 2023-02-03 GMT+08:00

Ver PDF

Consulta de la lista de almacén

Función

Esta API se utiliza para consultar la lista del almacén.

URI

GET /v3/{project_id}/vaults

**Tabla 1** Parámetros de path
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID de proyecto

**Tabla 2** Parámetros de Query
Parámetro	Obligatorio	Tipo	Descripción
cloud_type	No	String	Tipo de nube, que es el public
enterprise_project_id	No	String	ID de proyecto de empresa o all_granted_eps. all_granted_eps indica consultar los IDs de todos los proyectos de empresa en los que el usuario tiene permisos.
id	No	String	ID de almacén
limit	No	Integer	Número de registros mostrados por página. El valor debe ser un número positivo entero. Mínimo: 1 Máximo: 1000
name	No	String	Nombre de almacén
object_type	No	String	Tipo de objeto, que puede ser server o disk
offset	No	Integer	Valor de desplazamiento. El valor debe ser un número positivo entero.
policy_id	No	String	ID de política
protect_type	No	String	Tipo de protección, que es de backup
resource_ids	No	String	ID de recurso
status	No	String	Estado

Parámetros de solicitud

**Tabla 3** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	No	String	Token de usuario. El token se puede obtener llamando 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 token de usuario.

Parámetros de respuesta

Código de estado: 200

**Tabla 4** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
vaults	Array of Vault objects	Lista de instancias de almacén
count	Integer	Número de almacenes
limit	Integer	Número de registros mostrados en cada página Mínimo: 1 Máximo: 1000 Predeterminado: 1000
offset	Integer	Desplazamiento donde comienza la consulta Mínimo: 0 Predeterminado: 0

**Tabla 5** Vault
Parámetro	Tipo	Descripción
billing	Billing object	Información de la operación
description	String	Descripción del almacén definido por el usuario Mínimo: 0 Máximo: 255
id	String	ID de almacén
name	String	Nombre de almacén Mínimo: 1 Máximo: 64
project_id	String	ID de proyecto
provider_id	String	ID del tipo de recurso de almacén
resources	Array of ResourceResp objects	Recursos de almacén
tags	Array of Tag objects	Etiquetas de almacén
enterprise_project_id	String	ID de proyecto de empresa. Su valor predeterminado es 0.
auto_bind	Boolean	Indica si está habilitada la asociación automática. Su valor predeterminado es false (no habilitado).
bind_rules	VaultBindRules object	Regla de asociación
user_id	String	ID de usuario
created_at	String	Tiempo de creación, por ejemplo, 2020-02-05T10:38:34.209782
auto_expand	Boolean	Si se activa la ampliación automática de la capacidad para el almacén.
smn_notify	Boolean	Exception notification function Predeterminado: true
threshold	Integer	Umbral de capacidad del almacén. Si el uso de la capacidad del almacén supera este umbral, se envía una notificación de excepción. Mínimo: 1 Máximo: 100 Predeterminado: 80

**Tabla 6** Billing
Parámetro	Tipo	Descripción
allocated	Integer	Capacidad asignada, en GB.
charging_mode	String	Modo de facturación, que es el post_paid
cloud_type	String	Tipo de nube, que es el public
consistent_level	String	Especificación de almacén, que es crash_consistent de forma predeterminada (crash consistent backup)
object_type	String	Tipo de objeto, que puede ser server, disk, o turbo
order_id	String	ID del pedido
product_id	String	ID del producto
protect_type	String	Tipo de protección, que es de backup
size	Integer	Capacidad, en GB Mínimo: 1 Máximo: 10485760
spec_code	String	Almacén de copia de respaldo del servidor: vault.backup.server.normal; Almacén de copia de respaldo del disco: vault.backup.volume.normal; Almacén de copia de respaldo del sistema de archivos: vault.backup.turbo.normal
status	String	Estado del almacén Valores de enumeración: available lock frozen deleting error
storage_unit	String	Nombre del bucket del almacén
used	Integer	Capacidad utilizada, en MB.
frozen_scene	String	Escenario cuando una cuenta está congelada

**Tabla 7** ResourceResp
Parámetro	Tipo	Descripción
extra_info	ResourceExtraInfo object	Información adicional del recurso
id	String	ID del recurso al que se va a realizar una copia de seguridad
name	String	Nombre del recurso al que se va a hacer una copia de seguridad Mínimo: 0 Máximo: 255
protect_status	String	Estado de protección Valores de enumeración: available error protecting restoring removing
size	Integer	Capacidad asignada para los recursos asociados, en GB
type	String	Tipo del recurso que se va a hacer una copia de seguridad, que puede ser OS::Nova::Server, OS::Cinder::Volume, o OS::Sfs::Turbo
backup_size	Integer	Tamaño de copia de respaldo
backup_count	Integer	Cantidad de copias de respaldo

**Tabla 8** ResourceExtraInfo
Parámetro	Tipo	Descripción
exclude_volumes	Array of strings	ID de los discos de los que no se realizará una copia de seguridad. Este parámetro se utiliza cuando se agregan servidores a un almacén, que incluye todos los discos de servidor. Pero algunos discos no necesitan ser respaldados. O en caso de que se haya agregado un servidor previamente y no sea necesario realizar copias de seguridad de algunos discos de este servidor.

**Tabla 9** VaultBindRules
Parámetro	Tipo	Descripción
tags	Array of Tag objects	Filtra los recursos asociados automáticamente por etiqueta.

**Tabla 10** Tag
Parámetro	Tipo	Descripción
key	String	Clave Puede contener un máximo de 36 caracteres. No puede ser una cadena vacía. Los espacios antes y después de una clave serán descartados. No puede contener los siguientes caracteres: ASCII (0-31), signos iguales (=), asteriscos (*), corchetes angulares izquierdos (<), corchetes angulares rectos (>), barras invertidas (), comas (,), barras verticales (\|), y barras inclinadas (/) Puede contener solo letras, dígitos, guiones (-) y guiones bajos (_).
value	String	Valor Es obligatorio cuando se agrega una etiqueta y opcional cuando se elimina una etiqueta. Puede contener un máximo de 43 caracteres. Puede ser una cadena vacía. Los espacios antes y después de un valor serán descartados. No puede contener los siguientes caracteres: ASCII (0-31), signos iguales (=), asteriscos (*), corchetes angulares izquierdos (<), corchetes angulares rectos (>), barras invertidas (), comas (,), barras verticales (\|), y barras inclinadas (/) Puede contener solo letras, dígitos, guiones (-) y guiones bajos (_).

Solicitudes de ejemplo

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

Ejemplo de respuestas

Código de estado: 200

{
  "vaults" : [ {
    "id" : "a335f9e1-1628-4c64-a7be-38656e5ec19c",
    "name" : "vault-8538",
    "description" : null,
    "resources" : [ ],
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "created_at" : "2020-09-04T06:57:37.343535",
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "enterprise_project_id" : "0",
    "auto_bind" : false,
    "bind_rules" : { },
    "auto_expand" : false,
    "user_id" : "aa2999fa5ae640f28926f8fd79188934",
    "billing" : {
      "allocated" : 0,
      "cloud_type" : "public",
      "consistent_level" : "crash_consistent",
      "frozen_scene" : null,
      "charging_mode" : "post_paid",
      "order_id" : null,
      "product_id" : null,
      "protect_type" : "backup",
      "object_type" : "server",
      "spec_code" : "vault.backup.server.normal",
      "used" : 0,
      "storage_unit" : null,
      "status" : "available",
      "size" : 100
    },
    "tags" : [ ]
  } ],
  "count" : 50
}