ListTagResources - - Centro de documentación de Alibaba Cloud

Consulta las etiquetas agregadas a los recursos de Elastic Compute Service (ECS).

Notas de uso

Especifique como mínimo uno de los siguientes parámetros o pares de parámetros en una solicitud para determinar el objeto de consulta:

ResourceId.N
Par de parámetros Tag.N (Tag.N.Key y Tag.N.Value)
TagFilter.N

Si especifica alguno de los siguientes conjuntos de parámetros de solicitud como condiciones de filtro, solo se devuelven los recursos de ECS que cumplen con todas las condiciones indicadas:

Conjunto 1: Tag.N.Key, Tag.N.Value y ResourceId.N
Conjunto 2: TagFilter.N.TagKey, TagFilter.N.TagValues.N y ResourceId.N

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, le recomendamos llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListTagResources	La operación que desea ejecutar. Establezca el valor en ListTagResources.
RegionId	String	Sí	cn-hangzhou	El ID de región del recurso. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
NextToken	String	No	caeba0bbb2be03f84eb48b699f0a4883	Un token de paginación.
ResourceType	String	Sí	instance	El tipo de recurso. Valores válidos: instance: instancia disk: disco snapshot: instantánea image: imagen securitygroup: security group volume: volumen de almacenamiento eni: interfaz de red elástica (ENI) ddh: host dedicado ddhcluster: clúster de hosts dedicados keypair: key pair SSH launchtemplate: plantilla de lanzamiento reservedinstance: reserved instance snapshotpolicy: política de instantáneas automáticas elasticityassurance: garantía de elasticidad capacityreservation: reserva de capacidad command: comando de Cloud Assistant invocation: resultado de ejecución de comando de Cloud Assistant o resultado de entrega de archivo activation: código de activación para la instancia administrada de Cloud Assistant managedinstance: instancia administrada de Cloud Assistant
ResourceId.N	String	No	i-bp1j6qtvdm8w0z1o****	El ID del recurso N. Valores válidos de N: 1 a 50.
Tag.N.Key	String	No	TestKey	La clave de la etiqueta N que se usa para la búsqueda exacta de recursos de ECS. La clave de la etiqueta debe tener entre 1 y 128 caracteres de longitud. Valores válidos de N: 1 a 20. Métodos de uso del par de parámetros `Tag.N` (Tag.N.Key y Tag.N.Value): Método 1: Use este par de parámetros para la búsqueda exacta de recursos de ECS que tengan etiquetas específicas agregadas. Cada etiqueta es un par clave-valor. Si solo especifica `Tag.N.Key`, se devuelven todos los recursos de ECS cuyas etiquetas contengan la clave de etiqueta especificada. Si solo especifica `Tag.N.Value`, se devuelve el error `InvalidParameter.TagValue`. Si especifica varios pares clave-valor de etiqueta, solo se devuelven los recursos de ECS que tienen todos estos pares clave-valor agregados. Método 2: Use este par de parámetros para consultar información de recursos de un resource group no predeterminado. Establezca `Key` en `acs:rm:rgId` y `Value` en el ID de un resource group. Si establece `Key` en `acs:rm:rgId`, debe establecer `Value` en el ID de un resource group no predeterminado. Si establece Value en el ID del resource group predeterminado, se devuelve un mensaje de error. Si establece `Key` en `acs:rm:rgId`, no puede especificar otros pares de parámetros Tag.N. Si especifica varios pares de parámetros `Tag.N` para consultar resource groups y recursos al mismo tiempo, se devuelve un mensaje de error.
Tag.N.Value	String	No	TestValue	El valor de la etiqueta N que se usa para la búsqueda exacta de recursos de ECS. El valor de la etiqueta debe tener entre 1 y 128 caracteres de longitud. Valores válidos de N: 1 a 20. Nota Cuando Tag.1.Key se establece en `acs:rm:rgId`, solo puede establecer Tag.1.Value en el ID de un resource group no predeterminado.
TagFilter.N.TagValues.N	String	No	TestTagFilter	El valor de la etiqueta N que se usa para la búsqueda aproximada de recursos de ECS. El valor de la etiqueta debe tener entre 1 y 128 caracteres de longitud. Valores válidos de N: 1 a 5. Para obtener más información, consulte la descripción de `TagFilter.N.TagKey`.
TagFilter.N.TagKey	String	No	env	La clave de la etiqueta N que se usa para la búsqueda aproximada de recursos de ECS. La clave de la etiqueta debe tener entre 1 y 128 caracteres de longitud. Valores válidos de N: 1 a 5. El par de parámetros `TagFilter.N` (TagFilter.N.TagKey y TagFilter.N.TagValues.N) se usa para la búsqueda aproximada de recursos de ECS que tienen etiquetas específicas agregadas. En las etiquetas especificadas, una sola clave de etiqueta puede corresponder a uno o más valores de etiqueta. La búsqueda aproximada puede tener una latencia de 2 segundos y devolver un conjunto de resultados de hasta 5,000 recursos. Cuando usa `TagFilter.N.TagKey` para la búsqueda aproximada de recursos de ECS, debe dejar `TagFilter.N.TagValues.N` vacío. Por ejemplo, para consultar recursos de ECS cuyas etiquetas contengan la clave de etiqueta `environment`, puede establecer `TagFilter.1.TagKey` en `env` para búsqueda por prefijo, `env` para búsqueda por infijo, o `env` para búsqueda exacta, pero debe dejar `TagFilter.1.TagValues` vacío. Cuando usa `TagFilter.N.TagValues.N` para la búsqueda aproximada de recursos de ECS, debe establecer `TagFilter.N.TagKey` en un valor exacto. Por ejemplo, para consultar recursos de ECS que tienen una etiqueta compuesta por la clave `env` y el valor `product`, debe establecer `TagFilter.1.TagKey` en `env` y puede establecer `TagFilter.1.TagValues.1` en `proc` para búsqueda por prefijo, en `proc` para búsqueda por infijo, o en `proc` para búsqueda exacta. Solo se puede usar uno de los métodos de búsqueda anteriores para cada clave de etiqueta (`TagFilter.N.TagKey`). Si se configuran varios métodos de búsqueda para una clave de etiqueta, prevalece el primero. Si especifica varias claves de etiqueta, solo se devuelven los recursos de ECS que tienen todas las claves de etiqueta especificadas agregadas. Si especifica una clave de etiqueta que corresponde a varios valores de etiqueta, se devuelven todos los recursos de ECS que tienen uno o más de estos pares clave-valor de etiqueta agregados. Nota El par de parámetros `TagFilter.N` (TagFilter.N.TagKey y TagFilter.N.TagValues.N) no se puede usar junto con el par de parámetros `Tag.N` (Tag.N.Key y Tag.N.Value). De lo contrario, se devuelve un mensaje de error.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
NextToken	String	caeba0bbb2be03f84eb48b699f0a4883	El token necesario para la siguiente consulta.
RequestId	String	484256DA-D816-44D2-9D86-B6EE4D5BA78C	El ID de la solicitud.
TagResources	Array of TagResource		Detalles sobre los recursos y las etiquetas, incluidos los ID de recurso, los tipos de recurso y los pares clave-valor de etiqueta.
TagResource
TagValue	String	TestValue	El valor de la etiqueta del recurso.
ResourceType	String	instance	El tipo de recurso. Valores válidos: instance: instancia de ECS disk: disco snapshot: instantánea image: imagen securitygroup: security group volume: volumen de almacenamiento eni: ENI ddh: host dedicado ddhcluster: clúster de hosts dedicados keypair: key pair SSH launchtemplate: plantilla de lanzamiento reservedinstance: reserved instance snapshotpolicy: política de instantáneas automáticas elasticityassurance: garantía de elasticidad capacityreservation: reserva de capacidad command: comando de Cloud Assistant invocation: resultado de ejecución de comando de Cloud Assistant
ResourceId	String	i-bp1j6qtvdm8w0z1o****	El ID del recurso.
TagKey	String	TestKey	La clave de la etiqueta.

Ejemplos

Solicitudes de ejemplo

http(s)://ecs.aliyuncs.com/?Action=ListTagResources
&RegionId=cn-hangzhou
&ResourceType=instance
&ResourceId.1=i-bp1j6qtvdm8w0z1o****
&<Common request parameters>

Respuestas exitosas de ejemplo

XML formato

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTagResourcesResponse>
    <TagResources>
        <TagResource>
            <ResourceType>instance</ResourceType>
            <TagValue>TestValue</TagValue>
            <ResourceId>i-bp1j6qtvdm8w0z1o****</ResourceId>
            <TagKey>TestKey</TagKey>
        </TagResource>
    </TagResources>
    <RequestId>DE65F6B7-7566-4802-9007-96F2494AC512</RequestId>
</ListTagResourcesResponse>

JSON formato

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TagResources" : {
    "TagResource" : [ {
      "ResourceType" : "instance",
      "TagValue" : "TestValue",
      "ResourceId" : "i-bp1j6qtvdm8w0z1o****",
      "TagKey" : "TestKey"
    } ]
  },
  "RequestId" : "DE65F6B7-7566-4802-9007-96F2494AC512"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidDefaultResourceGroup.NotSupported	The specified parameter Tag is not support for default resource group.	No se puede consultar el resource group predeterminado.
400	InvalidTag.NotSupported	You can only specify Tag for either resource tag or resource group.	No se pueden consultar resource groups y etiquetas al mismo tiempo.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	La clave de etiqueta ya existe. Las claves de etiqueta deben ser únicas.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	Valor de Tag.N.Key no válido.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	Valor de Tag.N.Value no válido.
400	OperationDenied.QuotaExceed	The quota of tags on resource is beyond permitted range.	Se ha excedido el número máximo de etiquetas.
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	Los valores de Tag.N.Key y Tag.N.Value no se corresponden entre sí.
400	InvalidTagCount	The specified tags are beyond the permitted range.	Se ha excedido el número máximo de etiquetas.
400	Invalid.Scope	The specified scope is invalid.	Valor de Scope no válido.
403	PermissionDenied.TagOwnerUid	The specified operator not have permission to set TagOwnerUid value.	No tiene autorización para especificar el parámetro TagOwnerUid.
403	PermissionDenied.Scope	The specified operator not have permission to set Scope value.	No tiene autorización para especificar el parámetro Scope.
403	InvalidResourceId.NotSupported	The specified ResourceId does not support tagging.	El recurso especificado no admite etiquetado.
403	NoPermission.Tag	The operator is not permission for the tag.	No tiene autorización para gestionar la etiqueta.
404	InvalidRegionId.NotFound	%s	No se encuentra el ID de región especificado.
404	MissingParameter.ResourceType	The parameter - ResourceType should not be null.	ResourceType es obligatorio.
404	InvalidResourceId.NotFound	The specified ResourceIds are not found in our records.	No se encuentra el ID de recurso especificado. Compruebe si el ID de recurso es correcto.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.	No se encuentra el tipo de recurso especificado.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	Valor de RegionId no válido.
500	ServiceUnavailable	The service is unavailable, please try again later.	El servicio no está available temporalmente. Inténtelo de nuevo más tarde.
500	InternalError	The process of creating snapshot has failed due to some unknown error.	No se puede crear la instantánea.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.