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/ NAT Gateway/ Referencia de la API/ API fuera de fecha/ API v2.0/ Etiquetas/ Consulta de gateway de NAT por etiqueta

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

Ver PDF

Consulta de gateway de NAT por etiqueta

Función

Esta API se utiliza para filtrar los gateway de NAT por etiqueta.

TMS utiliza esta API para filtrar y enumerar los gateway de NAT por etiqueta.

De forma predeterminada, los gateway de NAT y las etiquetas se ordenan en orden descendente del tiempo de creación.

URI

Formato de URI

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

Descripción del parámetro

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

Solicitud

Tabla 2 describe los parámetros de solicitud.

**Tabla 2** Parámetros de solicitud
Parámetro	Obligatorio	Tipo	Descripción
tags	No	Array<Object>	Especifica las etiquetas incluidas. Cada etiqueta contiene un máximo de 10 claves, y cada clave contiene un máximo de 10 valores. El cuerpo de la estructura no puede faltar y la clave no se puede dejar en blanco o establecer una string vacía. Cada clave de etiqueta debe ser única y cada valor de etiqueta de una etiqueta debe ser único. Los recursos identificados por diferentes claves están en relación AND, y los valores en una etiqueta están en relación OR. Si no se especifica ningún criterio de filtrado de etiquetas, se devuelven los datos completos.
tags_any	No	Array<Object>	Especifica las etiquetas incluidas. Cada etiqueta contiene un máximo de 10 claves, y cada clave contiene un máximo de 10 valores. El cuerpo de la estructura no puede faltar y la clave no se puede dejar en blanco o establecer una string vacía. Cada clave de etiqueta debe ser única y cada valor de etiqueta de una etiqueta debe ser único. Los recursos identificados por diferentes claves están en relación OR, y los valores en una etiqueta están en relación OR. Si no se especifica ningún criterio de filtrado de etiquetas, se devuelven los datos completos.
not_tags	No	Array<Object>	Especifica las etiquetas excluidas. Cada etiqueta contiene un máximo de 10 claves, y cada clave contiene un máximo de 10 valores. El cuerpo de la estructura no puede faltar y la clave no se puede dejar en blanco o establecer una string vacía. Cada clave de etiqueta debe ser única y cada valor de etiqueta de una etiqueta debe ser único. Los recursos no identificados por diferentes claves están en relación AND, y los valores en una etiqueta están en relación OR. Si no se especifica ningún criterio de filtrado de etiquetas, se devuelven los datos completos.
not_tags_any	No	Array<Object>	Especifica las etiquetas excluidas. Cada etiqueta contiene un máximo de 10 claves, y cada clave contiene un máximo de 10 valores. El cuerpo de la estructura no puede faltar y la clave no se puede dejar en blanco o establecer una string vacía. Cada clave de etiqueta debe ser única y cada valor de etiqueta de una etiqueta debe ser único. Los recursos no identificados por diferentes claves están en relación OR, y los valores en una etiqueta están en relación OR. Si no se especifica ningún criterio de filtrado de etiquetas, se devuelven los datos completos.
limit	No	String	Número de registros. 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	No	String	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	Sí	String	Especifica la operación que se va a realizar, que sólo puede ser filter (filtrar) o count (consultar 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. No se permite devolver otros campos.
matches	No	Array<match>	Especifica los criterios de búsqueda. La clave de etiqueta es el campo que debe coincidir, por ejemplo, resource_name. El valor de etiqueta indica el valor coincidente. Este campo es un valor de diccionario fijo. Determinar si la coincidencia difusa es necesaria en función de diferentes campos. Por ejemplo, si key es resource_name, se utiliza la búsqueda difusa (sin distinción entre mayúsculas y minúsculas) de forma predeterminada. Si value es una string vacía, se utiliza la coincidencia exacta. Si key es resource_id, se utiliza la coincidencia exacta.

**Tabla 3** Descripción del parámetro del campo **tag**
Parámetro	Obligatorio	Tipo	Descripción
key	Sí	String	Especifica la clave de etiqueta. Puede contener un máximo de 127 caracteres de Unicode. no puede dejarse key en blanco, ser una string vacía o ser espacios. Antes de usar la clave, elimine espacios antes y después del valor.
values	Sí	Array<String>	Especifica los valores de etiqueta. Cada valor contiene un máximo de 255 caracteres Unicode y no puede contener espacios. Antes de la verificación, elimine los espacios antes y después del valor. El asterisco () es un carácter reservado. El valor puede estar vacío pero no se puede dejar en blanco. Si el valor comienza con un asterisco (), la string que sigue al asterisco es difusa. Si los valores son nulos, indica any_value (consultando cualquier valor). Los valores están en relación OR.

**Tabla 4** Descripción del campo **match**
Parámetro	Obligatorio	Tipo	Descripción
key	Sí	String	Especifica la clave de etiqueta. El valor se fija en resource_name.
value	Sí	String	Especifica el valor de clave. Puede contener un máximo de 255 caracteres Unicode.

Respuesta

Tabla 5 describe los parámetros de respuesta.

**Tabla 5** Parámetro de respuesta
Parámetro	Tipo	Descripción
resources	Array<resource>	Especifica la lista de objetos de recurso. Para más detalles, consulte Tabla 6.
total_count	Integer	Especifica el número total de recursos.

**Tabla 6** Descripción de la estructura de datos del campo **resource**
Parámetro	Tipo	Descripción
resource_id	String	Especifica el ID del recurso.
resource_detail	Object	Proporciona detalles sobre el recurso. El valor es un objeto de recurso, utilizado para la extensión. Este parámetro se deja en blanco por defecto.
tags	Array<resource_tag>	Especifica la lista de etiquetas consultadas. Si no hay ninguna etiqueta coincidente, se devuelve un array vacío. 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 parámetro del campo **resource_tag**
Parámetro	Tipo	Descripción
key	String	Especifica la clave de etiqueta. Contiene un máximo de 36 caracteres de Unicode. Una clave de etiqueta no se puede dejar en blanco. No puede contener caracteres ASCII no imprimibles (0–31) o los siguientes caracteres especiales: *<>\=
value	String	Especifica el valor de clave. El valor puede contener un máximo de 43 caracteres de Unicode y puede ser una string vacía. No puede contener caracteres ASCII (0–31) y los siguientes caracteres: *<>\=

Ejemplos

Ejemplo de la solicitud

Solicitar el cuerpo cuando action se establece como filter

POST  https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/resource_instances/action 
{
    "offset": "100", 
    "limit": "100", 
    "action": "filter", 
    "matches": [
        {
            "key": "resource_name", 
            "value": "nat_gateways"
        }
    ], 
    "not_tags": [
        {
            "key": "key1", 
            "values": [
                "*value1", 
                "value2"
            ]
        }
    ], 
    "tags": [
        {
            "key": "key2", 
            "values": [
                "*value3", 
                "value4"
            ]
        }
    ], 
    "tags_any": [
        {
            "key": "key3", 
            "values": [
                "*value5", 
                "value6"
            ]
        }
    ],
    "not_tags_any": [
        {
            "key": "key4", 
            "values": [
                "*value7", 
                "value8"
            ]
        }
    ]
}

Solicitar el cuerpo cuando action se establece en count

POST  https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/resource_instances/action        {
    "action": "count", 
    "matches": [
        {
            "key": "resource_name", 
            "value": "nat_gateways"
        }
    ], 
    "not_tags": [
        {
            "key": "key1", 
            "values": [
                "*value1", 
                "value2"
            ]
        }
    ], 
    "tags": [
        {
            "key": "key2", 
            "values": [
                "*value3", 
                "value4"
            ]
        }
    ], 
    "tags_any": [
        {
            "key": "key3", 
            "values": [
                "*value5", 
                "value6"
            ]
        }
    ],
    "not_tags_any": [
        {
            "key": "key4", 
            "values": [
                "*value7", 
                "value8"
            ]
        }
    ]
}

Ejemplo de la respuesta

Cuerpo de la respuesta cuando action se establece como filter

{ 
    "resources": [
        {
            "resource_detail": null, 
            "resource_id": "e5ad289f-9c56-4daf-b08b-2e53a983473a", 
            "resource_name": "nat_gateways", 
            "tags": [
                {
                   "key": "key2",
                   "value": "value4"
                },
                {
                   "key": "key2",
                   "value": "value3"
                }
            ]
        }
    ], 
    "total_count": 1000
}