Consulta de recursos de almacé
Función
Esta API se utiliza para filtrar recursos por etiqueta. Tag Management Service (TMS) utiliza esta API para filtrar y enumerar los recursos de cada servicio por etiqueta. Estos servicios deben tener las capacidades de consulta.
URI
POST /v3/{project_id}/vault/resource_instances/action
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
project_id |
Sí |
String |
ID de proyecto |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
without_any_tag |
No |
Boolean |
Si este parámetro se establece en true, se consultan todos los recursos sin etiquetas. En este caso, los campos tag, not_tags, tags_any, y not_tags_any son ignorados. |
tags |
No |
Array of TagsReq objects |
Lista de etiquetas incluidas. Las copias de seguridad con estas etiquetas se filtrarán. Esta lista no puede ser una lista vacía. La lista puede contener hasta 10 claves. Las claves de esta lista deben ser únicas. La respuesta devuelve recursos que contienen cualquier etiqueta de esta lista. Las claves de esta lista están en una relación AND mientras que los valores de cada estructura de key-value están en una relación OR. Si no se especifica ninguna condición de filtrado de etiquetas, se devuelven los datos completos. |
tags_any |
No |
Array of TagsReq objects |
Lista de etiquetas. Las copias de seguridad con cualquier etiqueta de esta lista serán filtradas. Esta lista no puede ser una lista vacía. La lista puede contener hasta 10 claves. Las claves de esta lista deben ser únicas. La respuesta devuelve recursos que contienen cualquier etiqueta de esta lista. Las claves de esta lista están en una relación OR mientras que los valores de cada estructura de key-value están en una relación OR. Si no se especifica ninguna condición de filtrado de etiquetas, se devuelven los datos completos. |
not_tags |
No |
Array of TagsReq objects |
Lista de etiquetas excluidas. Las copias de seguridad sin estas etiquetas se filtrarán. Esta lista no puede ser una lista vacía. La lista puede contener hasta 10 claves. Las claves de esta lista deben ser únicas. La respuesta devuelve recursos que no contienen etiquetas en esta lista. Las claves de esta lista están en una relación AND mientras que los valores de cada estructura de key-value están en una relación OR. Si no se especifica ninguna condición de filtrado de etiquetas, se devuelven los datos completos. |
not_tags_any |
No |
Array of TagsReq objects |
Lista de etiquetas. Las copias de seguridad sin etiquetas en esta lista serán filtradas. Esta lista no puede ser una lista vacía. La lista puede contener hasta 10 claves. Las claves de esta lista deben ser únicas. La respuesta devuelve recursos sin etiquetas en esta lista. Las claves de esta lista están en una relación OR mientras que los valores de cada estructura de key-value están en una relación OR. Si no se especifica ninguna condición de filtrado de etiquetas, se devuelven los datos completos. |
sys_tags |
No |
Array of SysTags objects |
Solo los usuarios con el permiso op_service pueden usar este campo para filtrar recursos. Actualmente, las llamadas TMS solo pueden tener una estructura de etiquetas. key: _sys_enterprise_project_id values: Lista de ID de proyecto de empresa Actualmente key contiene solo un valor. 0 indica el proyecto de empresa predeterminado. sys_tags y las condiciones de filtrado de etiquetas de inquilino (tags, tags_any, not_tags, y not_tags_any) no se pueden usar al mismo tiempo. Si no existe ninguna sys_tags, utilice otras API de etiquetas para filtrar. Si no se especifica ninguna condición de filtrado de etiquetas, se devuelven los datos completos. Esta lista no puede ser una lista vacía. |
limit |
No |
String |
Consultar conteo. (Este parámetro no se muestra cuando action está establecido en count.) Si la acción está establecida en filter, el valor predeterminado es 1000. El valor varía de 1 a 1000. Si establece un valor que no esté dentro de este intervalo, se informará de un error. El número de registros devueltos no excede el valor de límite. |
offset |
No |
String |
Posición del índice. (Este parámetro no se muestra cuando action está establecido en count). Si action se establece en filter, el valor predeterminado es 0 y el valor mínimo de offset es de 0. El primer registro del resultado de la consulta es el registro offset+1 que cumple los criterios de la consulta. |
action |
Sí |
String |
Identificador de operación. Los valores posibles son filter y count. El valor filter indica la consulta de paginación. El valor count indica que se devolverá el número total de resultados de consulta que cumplan los criterios de búsqueda. |
matches |
No |
Array of Match objects |
Lista de criterios de consulta soportados por recursos Esta lista no puede ser una lista vacía. Las claves de esta lista deben ser únicas. |
cloud_type |
No |
String |
Tipo de nube Valores de enumeración:
|
object_type |
No |
String |
Tipo de recurso Valores de enumeración:
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
key |
Sí |
String |
Clave Contiene un máximo de 127 caracteres Unicode. Una clave de etiqueta no puede ser una cadena vacía. Los espacios antes y después de una clave serán obsoletos. |
values |
Sí |
Array of strings |
List of values La lista puede contener hasta 10 valores. Un valor de etiqueta contiene hasta 255 caracteres Unicode. Los espacios antes y después de una clave serán obsoletos. Los valores de esta lista deben ser únicos. Los valores de esta lista están en una relación OR. Esta lista puede estar vacía y cada valor puede ser una cadena de caracteres vacía. Si esta lista se deja en blanco, indica que se incluyen todos los valores. El asterisco (*) es un carácter reservado en el sistema. Si el valor comienza con *, indica que la coincidencia difusa se realiza basándose en el valor siguiente a *. El valor no puede contener solo asteriscos. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
key |
Sí |
String |
Clave. Clave de la etiqueta del sistema, que se obtiene de la lista blanca y no se puede definir aleatoriamente. Actualmente, solo se admite el campo _sys_enterprise_project_id y el value correspondiente indica el ID del proyecto de empresa. |
values |
Sí |
Array of strings |
Lista de valores. Actualmente, solo se utiliza el ID del proyecto de empresa. El ID predeterminado del proyecto de empresa es 0. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
key |
Sí |
String |
Clave. Una clave solo se puede establecer en resource_name, e indica el nombre del recurso. |
value |
Sí |
String |
Valor. Un valor consta de hasta 255 caracteres Si key se establece en resource_name una cadena de caracteres vacía indica coincidencia exacta y cualquier cadena no vacía indica coincidencia difusa. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
|---|---|---|
resources |
Array of TagResource objects |
Lista de recursos emparejados (Este parámetro no se muestra si action está establecida en count.) |
total_count |
Integer |
Número total de recursos coincidentes |
Parámetro |
Tipo |
Descripción |
|---|---|---|
resource_id |
String |
ID de recurso |
resource_detail |
Array of Vault objects |
Detalles del recurso |
tags |
Array of Tag objects |
Lista de etiquetas. Si no hay ninguna etiqueta, se utiliza una matriz vacía de forma predeterminada. |
resource_name |
String |
Nombre de recurso |
sys_tags |
Array of SysTag objects |
Solo los usuarios con el permiso op_service pueden obtener este campo. Actualmente, solo se incluye resource_tag. key: _sys_enterprise_project_id value: ID del proyecto de empresa. El valor 0 indica el proyecto de empresa predeterminado. Este campo no se devuelve en el escenario de non-op_service. |
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 (_). |
Parámetro |
Tipo |
Descripción |
|---|---|---|
key |
String |
Clave. Clave de la etiqueta del sistema, que se obtiene de la lista blanca y no se puede definir aleatoriamente. Actualmente, solo se admite el campo _sys_enterprise_project_id y el value correspondiente indica el ID del proyecto de empresa. |
value |
String |
Valor. Actualmente, solo se utiliza el ID del proyecto de empresa. El ID predeterminado del proyecto de empresa es 0. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
|---|---|---|
error_code |
String |
Para obtener más información, consulte Códigos de error. |
error_msg |
String |
Mensaje de error |
Solicitudes de ejemplo
POST https://{endpoint}/v3/{project_id}/vault/resource_instances/action
{
"tags" : [ {
"key" : "string",
"values" : [ "value" ]
} ],
"action" : "filter"
}
Ejemplo de respuestas
Código de estado: 200
OK
{
"tags" : [ {
"key" : "string",
"value" : null
} ]
}
Códigos de estado
Código de estado |
Descripción |
|---|---|
200 |
OK |
400 |
Bad Request |
Códigos de error
Consulte Códigos de error.
