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> Domain Name Service> Referencia de la API> Las API> Gestión de etiquetas> Consulta de instancias de recurso mediante etiquetas

Actualización más reciente 2023-04-24 GMT+08:00

Ver PDF

Consulta de instancias de recurso mediante etiquetas

Función

Esta API se utiliza para consultar instancias de recursos mediante etiquetas.

Depuración

Puede depurar esta API mediante la autenticación automática en API Explorer o usar el código de ejemplo del SDK generado por API Explorer.

URI

POST /v2/{project_id}/{resource_type}/resource_instances/action

**Tabla 1** Parámetros de path
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID de proyecto
resource_type	Sí	String	Tipo de recurso. El valor puede ser DNS-public_zone, DNS-private_zone, DNS-public_recordset, DNS-private_recordset o DNS-ptr_record.

Parámetros de solicitud

**Tabla 2** Parámetros de encabezado de solicitud
Parámetro	Obligatorio	Tipo	Descripción
X-Auth-Token	Sí	String	Token de usuario. Se puede obtener mediante invocación a una API de IAM. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario.

**Tabla 3** Parámetros de body de solicitud
Parámetro	Obligatorio	Tipo	Descripción
tags	No	Array of tagValues objects	Etiquetas incluidas. El cuerpo de la estructura es obligatorio. Se permite un máximo de 10 claves de etiqueta en cada operación de consulta. La clave de etiqueta no se puede dejar en blanco ni establecer la cadena vacía. Una clave de etiqueta puede tener hasta 10 valores de etiqueta. Cada clave de etiqueta debe ser única y cada valor de etiqueta de una etiqueta debe ser único.
tags_any	No	Array of tagValues objects	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 cadena vacía. Cada clave de etiqueta debe ser única y cada valor de etiqueta de una etiqueta debe ser único.
not_tags	No	Array of tagValues objects	El cuerpo de la estructura es obligatorio. Se permite un máximo de 10 claves de etiqueta en cada operación de consulta. La clave de etiqueta no se puede dejar en blanco ni establecer la cadena vacía. Una clave de etiqueta puede tener hasta 10 valores de etiqueta. Cada clave de etiqueta debe ser única y cada valor de etiqueta de una etiqueta debe ser único.
not_tags_any	No	Array of tagValues objects	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 cadena vacía. Cada clave de etiqueta debe ser única y cada valor de etiqueta de una etiqueta debe ser único.
limit	No	Integer	Número de recursos en cada página. Rango de valores: de 1 a 1000. Si action se establece en filter, se utiliza el valor predeterminado 1000. Si action se establece en count, este parámetro no existe.
offset	No	Integer	Comience el desplazamiento de la consulta de paginación. La consulta comenzará a partir del siguiente recurso del valor de desplazamiento. Rango de valores: de 0 a 2147483647. Valor predeterminado: 0. Este parámetro no es necesario cuando se consultan los datos de 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 action se establece en filter, el valor predeterminado es 0. El valor debe ser un número y no puede ser un número negativo. Si action se establece en count, este parámetro no existe.
action	Sí	String	Operación a realizar. Opciones de valor: filter: Los recursos se consultan en las páginas por condición de filtro. count: Se consulta el número total de recursos.
matches	No	Array of match objects	Este parámetro especifica el par de clave-valor que se va a hacer coincidir en la consulta. Si value se deja en blanco, la coincidencia exacta funcionará. De lo contrario, la coincidencia difusa funcionará.

**Tabla 4** tagValues
Parámetro	Obligatorio	Tipo	Descripción
key	No	String	Clave de etiqueta. Una clave puede contener un máximo de 127 caracteres de Unicode. Debe especificarse key. (Este parámetro no se verifica durante la búsqueda.)
values	No	Array of strings	Valor de la etiqueta. Cada valor puede contener un máximo de 255 caracteres Unicode. El asterisco () es un carácter reservado. Si el valor comienza con un asterisco (), la coincidencia difusa se realiza basándose en el valor que sigue al asterisco (). Si falta values*, se hace coincidir cualquier valor. Todos los valores de una clave de etiqueta están en la relación OR.

**Tabla 5** match
Parámetro	Obligatorio	Tipo	Descripción
key	Sí	String	Clave de etiqueta. El valor actual es resource_name.
value	No	String	Valor de la etiqueta. Cada valor puede contener un máximo de 255 caracteres Unicode. El valor no puede contener guiones bajos (_) ni signos de porcentaje (%).

Parámetros de respuesta

Código de estado: 200

**Tabla 6** Parámetros de body de respuesta
Parámetro	Tipo	Descripción
resources	Array of resourceItem objects	Lista de etiquetas de recursos
total_count	Integer	Lista de etiquetas añadidas a un recurso

**Tabla 7** resourceItem
Parámetro	Tipo	Descripción
resource_id	String	ID de recurso
resource_detail	Object	Detalles del recurso. Este campo está reservado y su valor predeterminado es una cadena vacía.
tags	Array of tag objects	Lista de etiquetas. Si no hay ninguna etiqueta en la lista, se devuelve una matriz vacía.
resource_name	String	Nombre del recurso. Si no coincide ningún nombre de recurso, el valor se deja en blanco.

**Tabla 8** tag
Parámetro	Tipo	Descripción
key	String	Clave de etiqueta. Una clave puede contener hasta 36 caracteres de Unicode. No se puede dejar en blanco. Un valor de etiqueta no puede contener caracteres especiales (=*<>,\|/) ni empezar o terminar con espacios.
value	String	Valor de la etiqueta. Un valor de etiqueta contiene un máximo de 43 caracteres de Unicode y se puede dejar en blanco. Un valor de etiqueta no puede contener caracteres especiales (=*<>,\|/) ni empezar o terminar con espacios.

Solicitudes de ejemplo

{
  "offset" : "100",
  "limit" : "100",
  "action" : "filter",
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ],
  "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 respuestas

Código de estado: 200

Respuesta a la solicitud de consulta de recursos por etiqueta

{
  "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
}