ListTagResources - Tair (Redis® OSS-Compatible) - Centro de documentación de Alibaba Cloud

Consulta las etiquetas que se adjuntan a las instancias de base de datos de ApsaraDB for Tair (Redis® OSS-Compatible).

Descripción de la operación

Para las operaciones de consola correspondientes a esta API, consulte Filtrar instancias por etiqueta y Ver etiquetas vinculadas a una instancia.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

kvstore:ListTagResources

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región de la instancia.	cn-hangzhou
ResourceType	string	Sí	El tipo de recurso. Establezca el valor en INSTANCE. Valores válidos: INSTANCE : Instancia.	INSTANCE
NextToken	string	No	El token que se utiliza para iniciar la siguiente consulta y devolver más resultados. Nota No es necesario proporcionar este parámetro en la primera consulta. Si una consulta no devuelve todos los resultados, puede pasar el valor de NextToken devuelto en la consulta anterior en las consultas posteriores para continuar con la consulta.	212db86sca4384811e0b5e8707ec2****
ResourceId	array	No	La lista de ID de instancias. Nota Debe especificar al menos este parámetro o el parámetro Tag.	r-bp1zxszhcgatnx****
	string	No	El ID de la instancia.	r-bp1zxszhcgatnx****
Tag	array<object>	No	La información de las etiquetas de la instancia. Debe especificar al menos este parámetro o el parámetro ResourceId.
	object	No
Key	string	No	La clave de la etiqueta.	demokey
Value	string	No	El valor de la etiqueta.	demovalue

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El objeto.
NextToken	string	El token que se utiliza para iniciar la siguiente consulta. Si una consulta no devuelve todos los resultados, puede pasar el token devuelto en la consulta anterior en las consultas posteriores para continuar con la consulta.	212db86sca4384811e0b5e8707ec2****
RequestId	string	El ID de la solicitud.	47A514A1-4B77-4E30-B4C5-2A880650****
TagResources	object
TagResource	array<object>	La información sobre las instancias y las etiquetas.
	object	El objeto.
TagValue	string	El valor de la etiqueta.	demovalue
ResourceType	string	El tipo de recurso. El valor es fijo: ALIYUN::KVSTORE::INSTANCE, que indica una instancia de base de datos de ApsaraDB for Tair (Redis® OSS-Compatible).	ALIYUN::KVSTORE::INSTANCE
ResourceId	string	El ID del recurso, que es el ID de la instancia.	r-bp1zxszhcgatnx****
TagKey	string	La clave de la etiqueta.	demokey

Ejemplos

Respuesta exitosa

JSON Formato

{
  "NextToken": "212db86sca4384811e0b5e8707ec2****",
  "RequestId": "47A514A1-4B77-4E30-B4C5-2A880650****",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "demovalue",
        "ResourceType": "ALIYUN::KVSTORE::INSTANCE",
        "ResourceId": "r-bp1zxszhcgatnx****",
        "TagKey": "demokey"
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidTagKey.Malformed	The specified parameter Tag.n.Key or TagKey.n is not valid.
400	InvalidTagValue.Malformed	The specified parameter Tag.n.Value is not valid.
400	InvalidParameter.ResourceId	The specified parameter ResourceId.n is not valid.
400	MissParameter.TagOrResourceId	The parameter Tag.n or ResourceId.n is needed.	Los parámetros Tag y ResourceId no pueden estar ambos vacíos. Especifique al menos uno de ellos.
400	InvalidParameter.Scope	The specified parameter Scope is not valid.
400	NumberExceed.ResourceIds	The ResourceIds parameter number is exceed.
400	NumberExceed.Tags	The Tags parameter number is exceed.
400	Duplicate.TagKey	The specified parameter Tag.n.Key is duplicated.
400	InvalidParameter.ResourceType	The specified parameter ResourceType is not valid.
404	InvalidDbInstanceId.NotFound	Specified instance does not exist.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.