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 IP/ Referencia de la API/ Las API/ Gestión de etiquetas EIP/ Consulta de EIP por etiqueta

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

Ver PDF

Consulta de EIP por etiqueta

Función

Esta API se utiliza para consultar EIPs por etiqueta.

URI

POST /v2.0/{project_id}/publicips/resource_instances/action

Tabla 1 describe los parámetros.

**Tabla 1** Descripción del parámetro
Nombre	Obligatorio	Descripción
project_id	Sí	Especifica el ID del proyecto.

Mensaje de solicitud

Parámetro de solicitud

**Tabla 2** Parámetro de solicitud
Parámetro	Tipo	Obligatorio	Descripción
tags	Array of tags objects	No	Especifica las etiquetas incluidas. Se permite un máximo de 10 claves de etiqueta para cada operación de consulta. Cada clave de etiqueta puede tener hasta 10 valores de etiqueta. Se debe incluir el cuerpo de la estructura. La clave de etiqueta no se puede dejar en blanco ni establecer una string vacía. Cada clave de etiqueta debe ser única y cada valor de etiqueta de una etiqueta debe ser único.
limit	Integer	No	Establece el tamaño de página. Este parámetro no está disponible cuando action está establecida en count. El valor predeterminado es 1000 cuando action se establece en filter. El valor máximo es 1000, y el valor mínimo es 1. El valor no puede ser un número negativo.
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. Este parámetro no es necesario cuando consulta datos en la primera página. El valor de la respuesta devuelta para consultar datos en la página anterior se incluirá en este parámetro para consultar datos en páginas posteriores. Este parámetro no está disponible cuando action está establecida en count. Si action se establece en filter, el valor debe ser un número y el valor predeterminado es 0. El valor no puede ser un número negativo.
action	String	Sí	Especifica la operación que se va a realizar. El valor solo puede ser filter (filtrado) o count (consultando el número total). 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	Array of match objects	No	Especifica los criterios de búsqueda. La clave de etiqueta es el campo que debe coincidir. Actualmente, solo se admite resource_name. El valor de etiqueta indica el valor coincidente. Este campo es un valor de diccionario fijo.

**Tabla 3** Descripción del campo **tags**
Nombre	Obligatorio	Tipo	Descripción
key	Sí	String	Especifica la clave de etiqueta. El valor puede contener un máximo de 127 caracteres Unicode. La clave de etiqueta no se puede dejar en blanco. (Este parámetro no se verifica durante el proceso de búsqueda.)
values	Sí	Array of strings	Especifica la lista de valores de etiqueta. Cada valor puede contener un máximo de 255 caracteres Unicode. Una lista vacía para values indica cualquier valor. Los valores están en la relación OR.

**Tabla 4** Descripción del campo de **match**
Nombre	Obligatorio	Tipo	Descripción
key	Sí	String	Especifica la clave de etiqueta. Actualmente, la clave de etiqueta solo puede ser el nombre del recurso.
value	Sí	String	Especifica el valor de etiqueta. Cada valor puede contener un máximo de 255 caracteres Unicode.

Ejemplo de solicitud 1: Configuración de action para filter

POST https://{Endpoint}/v2.0/{project_id}/publicips/resource_instances/action

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

Ejemplo de solicitud 2: Configuración de action para count

{
    "action": "count",
    "tags": [
        {
            "key": "key1",
            "values": [
                "value1",
                "value2"
            ]
        },
        {
            "key": "key2",
            "values": [
                "value1",
                "value2"
            ]
        }
    ],
    "matches": [
        {
            "key": "resource_name",
            "value": "resource1"
        }
    ]
}

Mensaje de la respuesta

Parámetro de respuesta

**Tabla 5** Parámetro de respuesta
Nombre	Tipo	Descripción
resources	Array of resource objects	Especifica la lista de objetos resource. Para más detalles, consulte Tabla 6.
total_count	Integer	Especifica el número total de registros de consulta.

**Tabla 6** Objetos **resource**
Nombre	Tipo	Descripción
resource_id	String	Especifica el ID del recurso.
resource_detail	Object	Especifica los detalles del recurso. Los detalles de los recursos se utilizan para la extensión. Este parámetro se deja en blanco por defecto.
tags	Array of tags objects	Especifica la lista de etiquetas. Este parámetro es un array vacío por defecto si no hay etiqueta. Para más detalles, consulte Tabla 7.
resource_name	String	Especifica el nombre del recurso. Este parámetro es una string vacía de forma predeterminada si no hay un nombre de recurso.

**Tabla 7** Descripción del campo **tags**
Nombre	Obligatorio	Tipo	Descripción
key	Sí	String	Especifica la clave de etiqueta. El valor puede contener un máximo de 127 caracteres Unicode. La clave de etiqueta no se puede dejar en blanco. (Este parámetro no se verifica durante el proceso de búsqueda.)
value	Sí	String	Especifica la lista de valores de etiqueta. Cada valor puede contener un máximo de 255 caracteres Unicode. Una lista vacía para values indica cualquier valor. Los valores están en la relación OR.

Ejemplo de respuesta 1: Configuración de action para filter

{ 
      "resources": [
         {
            "resource_detail": null, 
            "resource_id": "cdfs_cefs_wesas_12_dsad", 
            "resource_name": "resouece1", 
            "tags": [
                {
                   "key": "key1",
                   "value": "value1"
                },
                {
                   "key": "key2",
                   "value": "value1"
                }
             ]
         }
       ], 
      "total_count": 1000
}