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/ Dedicated Host/ Referencia de la API/ API/ Gestión de etiquetas de DeH/ Consulta de DeHs por etiqueta

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

Ver PDF

Consulta de DeHs por etiqueta

Función

Esta API se utiliza para filtrar DeHs por etiqueta y devolver la lista de todas las etiquetas de un DeH.

Tag Management Service (TMS) utiliza esta API para filtrar el DeHs.

URI

POST /v1.0/{project_id}/dedicated-host-tags/resource_instances/action

Tabla 1 describe los parámetros.

**Tabla 1** Descripción de parámetros
Parámetro	Tipo	Obligatorio	Descripción
project_id	String	Sí	Especifica el ID del proyecto.

Solicitud

Parámetros de solicitud

**Tabla 2** Parámetros de solicitud
Parámetro	Tipo	Obligatorio	Descripción
tags	Array of objects	No	Muestra todas las DeHs con las etiquetas especificadas. Para obtener más información, consulte Tabla 3. Se puede incluir un máximo de 10 claves. Cada clave puede tener un máximo de 10 valores. Se debe incluir el cuerpo de la estructura. La clave de etiqueta no se puede dejar en blanco ni establecer una cadena vacía. Una clave debe ser única. Los valores de la misma clave deben ser únicos.
not_tags	Array of objects	No	Muestra el DeHs sin ninguna de las etiquetas especificadas. Para obtener más información, consulte Tabla 3. Se puede incluir un máximo de 10 claves. Cada clave puede tener un máximo de 10 valores. Se debe incluir el cuerpo de la estructura. La clave de etiqueta no se puede dejar en blanco ni establecer una cadena vacía. Las claves deben ser únicas. Los valores de la misma clave deben ser únicos.
limit	Integer	No	Limita el número máximo de DeHs consultados. El valor no puede ser un número negativo. El valor máximo es 1000. Si el valor action es de count, este parámetro no es válido. Si el valor de action es filter, el valor predeterminado es 1000.
offset	Integer	No	Especifica la posición del índice. La consulta comienza a partir de la siguiente pieza de datos indexada por este parámetro. El valor debe ser un número no negativo. No es necesario especificar este parámetro al consultar recursos en la primera página. Cuando consulte recursos en páginas posteriores, establezca el valor de offset en la ubicación devuelta en el cuerpo de la respuesta de la consulta anterior. Si el valor action es de count, este parámetro no es válido. Si el valor de action es filter, el valor predeterminado es 0.
action	String	Sí	Especifica la operación, que puede ser filter o count. filter: Filtra los DeHs por etiqueta y enumera los DeHs que cumplen con los criterios de búsqueda. Las DeHs listadas se consultan por página. count Busca DeHs por etiqueta y devuelve el número de DeHs que cumplen los criterios de búsqueda.
tags_any	Array of objects	No	Incluye cualquiera de las etiquetas especificadas. Para obtener más información, consulte Tabla 3. Este campo contiene un máximo de 10 claves de etiqueta y cada clave de etiqueta tiene un máximo de 10 valores de etiqueta. El valor de etiqueta correspondiente a cada clave de etiqueta puede ser una matriz vacía, pero la estructura no puede faltar. Cada clave debe ser única y no puede contener valores duplicados. La respuesta devuelve recursos que contienen las etiquetas de esta lista. Las claves de esta lista están en una relación OR y los valores de cada estructura clave-valor también 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	Array of objects	No	Excluye cualquiera de las etiquetas especificadas. Para obtener más información, consulte Tabla 3. Este campo contiene un máximo de 10 claves de etiqueta y cada clave de etiqueta tiene un máximo de 10 valores de etiqueta. El valor de etiqueta correspondiente a cada clave de etiqueta puede ser una matriz vacía, pero la estructura no puede faltar. Cada clave debe ser única y no puede contener valores duplicados. La respuesta devuelve recursos que no contienen etiquetas en esta lista. Las claves de esta lista están en una relación OR y los valores de cada estructura clave-valor también están en una relación OR. Si no se especifica ninguna condición de filtrado de etiquetas, se devuelven los datos completos.
matches	Array of objects	No	Especifica el campo de búsqueda, que se utiliza para buscar DeHs por condición. Actualmente, solo se pueden utilizar resource_name para la búsqueda. Para obtener más información, consulte Tabla 4.

**Tabla 3** descripción del campo **tag**
Parámetro	Tipo	Obligatorio	Descripción
key	String	Sí	Especifica la clave de etiqueta. Contiene un máximo de 127 caracteres Unicode. Este campo es obligatorio.
values	Array of strings	No	Especifica los valores de etiqueta. Cada etiqueta contiene un máximo de 10 valores. Los valores de la misma etiqueta deben ser únicos. Cada valor puede contener un máximo de 255 caracteres Unicode. Si no se especifica este parámetro, se puede usar cualquier valor. Los recursos que contienen uno o más valores enumerados en el values se encontrarán y se mostrarán.

**Tabla 4** Descripción del campo **match**
Parámetro	Tipo	Obligatorio	Descripción
key	String	Sí	Especifica el parámetro clave que se va a hacer coincidir. La clave debe ser única, y el valor se utiliza para la coincidencia. El campo key es un valor de diccionario fijo. Este campo es obligatorio. NOTA: El valor del parámetro solo puede ser resource_name, que es el nombre DeH.
value	String	Sí	Especifica el valor de etiqueta. Cada valor puede contener un máximo de 255 caracteres Unicode. Este campo es obligatorio.

Solicitud de ejemplo

POST https://{Endpoint}/v1.0/9c53a566cb3443ab910cf0daebca90c4/dedicated-host-tags/resource_instances/action

{ 
    "offset": "0",
    "limit": "100",
    "action": "filter",
    "matches": [
        {
            "key": "resource_name",
            "value": "resource1"
        }
    ],
    "tags": [
        {
            "key": "key1",
            "values": ["value1"]
        }
    ]
}

Respuesta

Parámetros de respuesta

**Tabla 5** Parámetros de respuesta
Parámetro	Tipo	Descripción
resources	Array of objects	Especifica la lista DeH devuelta. Para obtener más información, véase Tabla 6.
total_count	Integer	Especifica el número total de recursos.

**Tabla 6** Descripción del campo **resource**
Parámetro	Tipo	Descripción
resource_id	String	Especifica el ID de DeH.
resouce_detail	String	Especifica los detalles de DeH. Este campo se utiliza para la extensión futura y se deja vacío por defecto.
tags	Array of objects	Especifica la lista de etiquetas. Para obtener más información, véase Tabla 7.
resource_name	String	Especifica el nombre del recurso.

**Tabla 7** descripción del campo **tag**
Parámetro	Tipo	Descripción
key	String	Especifica la clave de etiqueta. Contiene un máximo de 36 caracteres Unicode. Este campo es obligatorio. No puede contener los siguientes caracteres ASCII: =*<>\\|/,
value	String	Especifica el valor de etiqueta. Cada valor contiene un máximo de 43 caracteres Unicode. Este campo se puede dejar en blanco. No puede contener los siguientes caracteres ASCII: =*<>\\|/,

Ejemplo de respuesta

Cuerpo de la respuesta cuando action se establece como filter

{
    "resources": [
        {
            "resource_detail": null,
            "resource_id": "cdfs_cefs_wesas_12_dsad",
            "resource_name": "resource1",
            "tags": [
                {
                    "key": "key1",
                    "value": "value1"
                }
            ]
        }
    ],
    "total_count": 1
}

Cuerpo de respuesta cuando action está configurada para count