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/ Elastic Cloud Server/ Referencia de la API/ API (recomendado)/ Gestión de etiquetas/ Consulta de ECS por etiqueta

Actualización más reciente 2022-11-08 GMT+08:00

Consulta de ECS por etiqueta

Función

Esta API se utiliza para filtrar ECS por etiqueta y obtener todas las etiquetas y recursos utilizados por un ECS.

URI

POST /v1/{project_id}/cloudservers/resource_instances/action

Tabla 1 describe los parámetros en el URI.

**Tabla 1** Descripción del parámetro
Parámetro	Obligatorio	Descripción
project_id	Sí	Especifica el ID del proyecto. Para obtener más información sobre cómo obtener el ID, consulte Obtención de un ID de proyecto.

Solicitud

Tabla 2 describe los parámetros de solicitud.

**Tabla 2** Parámetros de solicitud
Parámetro	Obligatorio	Tipo	Descripción
action	Sí	String	Especifica la operación. El valor filter indica que se deben filtrar los ECS por etiqueta. Se muestran los ECS que cumplen los criterios de filtro.
limit	No	String	Limita el número máximo de ECS consultados. El valor no puede ser un número negativo. El valor máximo es 1000. Si el valor action es count, este parámetro no es válido. Si el valor action es filter, este parámetro es obligatorio. El valor varía de 0 a 1000. Si no se especifica ningún valor para limit, el valor predeterminado de este parámetro es 1000.
offset	No	String	Especifica el inicio del registro que se va a devolver. El valor debe ser un número que sea mayor o igual a 0. Este parámetro es opcional cuando se consultan los datos de la primera página. Si el valor action es count, este parámetro no es válido. Si el valor action es filter, este parámetro es obligatorio. Si no se especifica ningún valor para offset, el valor predeterminado de este parámetro es 0.
tags	No	Array of objects	Muestra los ECS con todas las etiquetas especificadas. Para más detalles, consulte Tabla 3. Se incluyen 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 string vacía. Una clave debe ser única. Los valores de la misma clave deben ser únicos.
not_tags	No	Array of strings	Muestra los ECS sin ninguna de las etiquetas especificadas. Se incluyen 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 string vacía. La clave deben ser única. Los valores de la misma clave deben ser únicos.
matches	No	Array of objects	Especifica el campo de búsqueda, que se utiliza para buscar ECS. Actualmente, solo se puede usar resource_name para la búsqueda. Para obtener más información, consulte Tabla 4.

**Tabla 3** Descripción del campo **tag**
Parámetro	Obligatorio	Tipo	Descripción
key	Sí	String	Especifica la clave de etiqueta. Contiene un máximo de 127 caracteres Unicode. No se puede dejar en blanco.
values	Sí	Array of strings	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 contiene un máximo de 255 caracteres Unicode. Si no se especifica este parámetro, su valor es any_value. Los valores están en la relación OR.

**Tabla 4** Descripción del campo **match**
Parámetro	Obligatorio	Tipo	Descripción
key	Sí	String	Especifica el campo de clave que se va a hacer coincidir. La clave de etiqueta solo puede ser resource_name. En tal caso, el valor de etiqueta es el nombre de ECS. La clave debe ser única, y el valor se utiliza para la coincidencia. Este campo es un valor de diccionario fijo. Este campo es obligatorio.
value	Sí	String	Especifica el valor de etiqueta. La clave de etiqueta solo puede ser resource_name. En tal caso, el valor de etiqueta es el nombre de ECS. Contiene un máximo de 255 caracteres Unicode. No se puede dejar en blanco.

Respuesta

Parámetros de respuesta

Tabla 5 describe los parámetros de respuesta.

**Tabla 5** Parámetros de respuesta
Parámetro	Tipo	Descripción
resources	Array of objects	Especifica los ECS devueltos. Para más detalles, consulte Tabla 6.
total_count	Integer	Especifica el número total de ECS consultados.

**Tabla 6** Descripción del campo **resource**
Parámetro	Tipo	Descripción
resource_id	String	Especifica el ID del ECS.
resource_detail	String	Reservada
tags	Array of objects	Enumera las etiquetas.
resource_name	String	Especifica el nombre del recurso, que es el nombre de ECS.

**Tabla 7** Descripción del campo **resource_tag**
Parámetro	Tipo	Descripción
key	String	Especifica la clave de etiqueta. Contiene un máximo de 127 caracteres Unicode. No se puede dejar en blanco. Consta de solo dígitos, letras, guiones (-) y guiones bajos (_).
value	String	Especifica el valor de etiqueta. Contiene un máximo de 255 caracteres Unicode. Se puede dejar en blanco. Consta de solo dígitos, letras, guiones (-) y guiones bajos (_).

Ejemplos

Ejemplo de la solicitud

POST  https://{endpoint}/v1/{project_id}/cloudservers/resource_instances/action

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

Ejemplo de la respuesta

{
      "resources": [
         {
            "resource_detail": null, 
            "resource_id": "31760ffa-6711-406d-bc94-bce4ae925a8a", 
            "resource_name": "ecs_test", 
            "tags": [
                {
                   "key": "key1",
                   "value": "value1"
                }
             ]
         }
       ], 
      "total_count": 1000
}