Consulta de un almacén especificado
Función
Esta API se utiliza para consultar un almacén especificado basado en su ID.
URI
GET /v3/{project_id}/vaults/{vault_id}
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| project_id | Sí | String | ID de proyecto |
| vault_id | Sí | String | ID de almacén |
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| X-Auth-Token | Sí | 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
| Parámetro | Tipo | Descripción |
|---|---|---|
| vault | Vault object | Objetos devueltos después de la consulta por un almacén |
| 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 | Función de notificación de excepción 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 |
| 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:
|
| storage_unit | String | Nombre del bucket del almacén |
| used | Integer | Capacidad utilizada, en MB. |
| frozen_scene | String | Escenario cuando una cuenta está congelada |
| 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:
|
| 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 |
| 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. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| tags | Array of Tag objects | Filtra los recursos asociados automáticamente por etiqueta. |
| 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 (_). |
Código de estado: 404
| Parámetro | Tipo | Descripción |
|---|---|---|
| vault | Vault object | Objetos devueltos después de la consulta por un almacén |
| 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 | Función de notificación de excepción 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 |
| 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:
|
| storage_unit | String | Nombre del bucket del almacén |
| used | Integer | Capacidad utilizada, en MB. |
| frozen_scene | String | Escenario cuando una cuenta está congelada |
| 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:
|
| 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 |
| 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. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| tags | Array of Tag objects | Filtra los recursos asociados automáticamente por etiqueta. |
| 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/{vault_id} Ejemplo de respuestas
Código de estado: 200
OK
{
"vault" : {
"id" : "2b076f26-391f-40fa-bf71-a798940faccf",
"name" : "sdk-vault1595581958",
"description" : null,
"resources" : [ ],
"provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
"created_at" : "2020-07-24T09:12:49.491874",
"project_id" : "0605767b5780d5762fc5c0118072a564",
"enterprise_project_id" : "0",
"auto_bind" : true,
"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" : 40
},
"tags" : [ {
"key" : "fds",
"value" : null
} ]
}
} Códigos de estado
| Código de estado | Descripción |
|---|---|
| 200 | OK |
| 404 | Not Found |
Códigos de error
Consulte Códigos de error.