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> MapReduce Service> Referencia de la API> API V1.1> Las API de gestión de etiquetas> Consulta de una lista de clústeres con etiquetas especificadas
Actualización más reciente 2023-07-28 GMT+08:00

Consulta de una lista de clústeres con etiquetas especificadas

Función

Esta API se utiliza para filtrar clústeres por etiqueta.

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

Restricciones

Ninguna

Depuración

Puede depurar esta API a través de la autenticación automática en API Explorer. API Explorer puede generar automáticamente código SDK de ejemplo y proporcionar la depuración de código SDK de ejemplo.

URI

  • Formato

    POST /v1.1/{project_id}/clusters/resource_instances/action

  • Descripción de parámetro
    Tabla 1 Parámetros de URI

    Parámetro

    Obligatorio

    Tipo

    Descripción

    project_id

    String

    El ID del proyecto. Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.

Parámetros de solicitud

Tabla 2 Parámetros de body de solicitud

Parámetro

Obligatorio

Tipo

Descripción

tags

No

Array of TagWithMultiValue objects

El resultado devuelto contiene recursos correspondientes a todas las etiquetas de este parámetro. Este parámetro 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 cadena vacía. Para obtener más información sobre los parámetros, consulte Tabla 3.

tags_any

No

Array of TagWithMultiValue objects

El resultado devuelto contiene recursos correspondientes a cualquier etiqueta en este parámetro. Este parámetro 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 cadena vacía. Las claves deben ser únicas y los valores de una clave deben ser únicos. Para obtener más información sobre los parámetros, consulte Tabla 3.

not_tags

No

Array of TagWithMultiValue objects

El resultado devuelto no contiene recursos correspondientes a todas las etiquetas de este parámetro. Este parámetro 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 cadena vacía. Las claves deben ser únicas y los valores de una clave deben ser únicos. Para obtener más información sobre los parámetros, consulte Tabla 3.

not_tags_any

No

Array of TagWithMultiValue objects

El resultado devuelto no contiene recursos correspondientes a ninguna etiqueta en este parámetro. Este parámetro 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 cadena vacía. Las claves deben ser únicas y los valores de una clave deben ser únicos. Para obtener más información sobre los parámetros, consulte Tabla 3.

limit

No

Integer

Número de registros. Este parámetro no está disponible cuando action está establecida en count. El valor predeterminado es 1000 cuando action está establecido en filter. El valor máximo es de 1000 y el valor mínimo de 1. El valor no puede ser un número negativo.

offset

No

Integer

Posición del índice. La consulta comienza a partir del siguiente dato especificado por el parámetro offset. Este parámetro no es necesario cuando consulta datos en la primera página. El valor del cuerpo de respuesta devuelto 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

Operación a realizar. El valor puede ser filter o 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

Campo de búsqueda. key indica el campo que se va a hacer coincidir, por ejemplo, resource_name. value 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 tiene un valor resource_name, se utiliza la búsqueda difusa de forma predeterminada. Si value es una cadena vacía, se utiliza la coincidencia exacta. Para obtener más información sobre los parámetros, consulte Tabla 4.

Tabla 3 TagWithMultiValue

Parámetro

Obligatorio

Tipo

Descripción

key

String

Clave. Una clave de etiqueta no puede contener caracteres especiales (=*<>\,|/) ni empezar o terminar con espacios.

values

No

Array of strings

Lista de valores.

Un valor de etiqueta no puede contener caracteres especiales (=*<>\,|/) ni empezar o terminar con espacios.

Tabla 4 Match

Parámetro

Obligatorio

Tipo

Descripción

key

No

String

Clave. Actualmente, solo está disponible resource_name, que indica el nombre del clúster. Más adelante se admitirán otras claves.

value

No

String

Valor. Un valor contiene un máximo de 64 caracteres Unicode.

Respuesta

Tabla 5 Parámetros de respuesta

Parámetro

Tipo

Descripción

resources

Array of MRSResource objects

Detalles del recurso. Para obtener más información, consulte Tabla 6.

total_count

Integer

Número total de recursos.

Tabla 6 MRSResource

Parámetro

Tipo

Descripción

resource_detail

String

Detalles del recurso.

resource_id

String

ID del recurso.

resource_name

String

Nombre del recurso.

tags

Array of TagPlain objects

Lista de etiquetas. Para obtener más información, consulte Tabla 7.

Tabla 7 TagPlain

Parámetro

Tipo

Descripción

key

String

Clave. Una clave de etiqueta no puede contener caracteres especiales (=*<>\,|/) ni empezar o terminar con un espacio.

value

String

Valor de etiqueta. Un valor de etiqueta no puede contener caracteres especiales (=*<>\,|/) ni comenzar o terminar con un espacio.

Solicitud de ejemplo

  • Ejemplo de solicitud cuando action está establecido en filter
    POST https://{endpoint}/v1.1/{project_id}/{resource_type}/resource_instances/action
    
    {
      "offset" : "100",
      "limit" : "100",
      "action" : "filter",
      "matches" : [ {
        "key" : "resource_name",
        "value" : "clusterA"
      } ],
      "not_tags" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      } ],
      "tags" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      } ],
      "tags_any" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      } ],
      "not_tags_any" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      } ]
    }
  • Ejemplo de solicitud cuando action está establecido en count
    POST https://{endpoint}/v1.1/{project_id}/{resource_type}/resource_instances/action
    
    {
      "action" : "count",
      "not_tags" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      } ],
      "tags" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      }, {
        "key" : "key2",
        "values" : [ "value1", "value2" ]
      } ],
      "tags_any" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      } ],
      "not_tags_any" : [ {
        "key" : "key1",
        "values" : [ "value1", "value2" ]
      } ],
      "matches" : [ {
        "key" : "resource_name",
        "value" : "clusterA"
      } ]
    }

Ejemplo de respuesta

Código de estado: 200

La operación es exitosa.

  • Ejemplo 1
    {
      "resources" : [ {
        "resource_detail" : null,
        "resource_id" : "cdfs_cefs_wesas_12_dsad",
        "resource_name" : "clusterA",
        "tags" : [ {
          "key" : "key1",
          "value" : "value1"
        }, {
          "key" : "key2",
          "value" : "value1"
        } ]
      } ],
      "total_count" : "1000"
    }
  • Ejemplo 2
    {
      "total_count" : "1000"
    }

Códigos de estado

Consulte Códigos de estado.

Códigos de error

Consulte Códigos de error.