ListTagResources - : Central de Documentação do Alibaba Cloud

Observações de uso

Especifique pelo menos um dos seguintes parâmetros ou pares de parâmetros na solicitação para definir o objeto da consulta:

ResourceId.N
Par de parâmetros Tag.N (Tag.N.Key e Tag.N.Value)
TagFilter.N

Ao especificar um dos seguintes conjuntos de parâmetros como condições de filtro, a API retorna apenas os recursos ECS que atendem a todos os critérios definidos:

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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListTagResources	A operação a ser executada. Defina o valor como ListTagResources.
RegionId	String	Sim	cn-hangzhou	ID da região do recurso. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
NextToken	String	Não	caeba0bbb2be03f84eb48b699f0a4883	Token de paginação.
ResourceType	String	Sim	instance	Tipo do recurso. Valores válidos: instance: instância disk: disco snapshot: snapshot image: imagem securitygroup: grupo de segurança volume: volume de armazenamento eni: interface de rede elástica (ENI) ddh: host dedicado ddhcluster: cluster de hosts dedicados keypair: par de chaves SSH launchtemplate: modelo de inicialização reservedinstance: instância reservada snapshotpolicy: política de snapshot automático elasticityassurance: garantia de elasticidade capacityreservation: reserva de capacidade command: comando do Cloud Assistant invocation: resultado da execução de comando do Cloud Assistant ou resultado de entrega de arquivo activation: código de ativação para a instância gerenciada do Cloud Assistant managedinstance: instância gerenciada do Cloud Assistant
ResourceId.N	String	Não	i-bp1j6qtvdm8w0z1o****	ID do recurso N. Valores válidos de N: 1 a 50.
Tag.N.Key	String	Não	TestKey	Chave da tag N usada para busca exata de recursos ECS. A chave da tag deve ter de 1 a 128 caracteres. Valores válidos de N: 1 a 20. Métodos de uso do par de parâmetros `Tag.N` (Tag.N.Key e Tag.N.Value): Método 1: use este par de parâmetros para buscar exatamente os recursos ECS com tags específicas. Cada tag é um par chave-valor. Se você especificar apenas `Tag.N.Key`, a API retornará todos os recursos ECS cujas tags contêm a chave especificada. Caso especifique apenas `Tag.N.Value`, o erro `InvalidParameter.TagValue` será retornado. Ao especificar vários pares chave-valor de tag, apenas os recursos ECS que possuem todos esses pares são retornados. Método 2: use este par de parâmetros para consultar informações de recursos de um grupo de recursos não padrão. Defina `Key` como `acs:rm:rgId` e `Value` como o ID de um grupo de recursos. Ao definir `Key` como `acs:rm:rgId`, defina `Value` obrigatoriamente como o ID de um grupo de recursos não padrão. Se você definir Value como o ID do grupo de recursos padrão, uma mensagem de erro será retornada. Quando `Key` for definido como `acs:rm:rgId`, não especifique outros pares de parâmetros Tag.N. A tentativa de usar múltiplos pares `Tag.N` para consultar grupos de recursos e recursos simultaneamente resulta em uma mensagem de erro.
Tag.N.Value	String	Não	TestValue	Valor da tag N usado para busca exata de recursos ECS. O valor da tag deve ter de 1 a 128 caracteres. Valores válidos de N: 1 a 20. Nota Quando Tag.1.Key estiver definido como `acs:rm:rgId`, defina Tag.1.Value apenas como o ID de um grupo de recursos não padrão.
TagFilter.N.TagValues.N	String	Não	TestTagFilter	Valor da tag N usado para busca aproximada de recursos ECS. O valor da tag deve ter de 1 a 128 caracteres. Valores válidos de N: 1 a 5. Para mais informações, consulte a descrição de `TagFilter.N.TagKey`.
TagFilter.N.TagKey	String	Não	env	Chave da tag N usada para busca aproximada de recursos ECS. A chave da tag deve ter de 1 a 128 caracteres. Valores válidos de N: 1 a 5. O par de parâmetros `TagFilter.N` (TagFilter.N.TagKey e TagFilter.N.TagValues.N) permite buscar aproximadamente recursos ECS com tags específicas. Nessas tags, uma única chave pode corresponder a um ou mais valores. A busca aproximada pode apresentar latência de 2 segundos e retorna um conjunto de resultados com até 5.000 recursos. Ao utilizar `TagFilter.N.TagKey` para busca aproximada, deixe `TagFilter.N.TagValues.N` vazio. Por exemplo, para consultar recursos ECS cujas tags contenham a chave `environment`, defina `TagFilter.1.TagKey` como `env` para busca por prefixo, `env` para busca por infixo ou `env` para busca exata, mantendo `TagFilter.1.TagValues` vazio. Para usar `TagFilter.N.TagValues.N` na busca aproximada, defina `TagFilter.N.TagKey` com um valor exato. Por exemplo, para encontrar recursos ECS com uma tag composta pela chave `env` e pelo valor `product`, defina `TagFilter.1.TagKey` como `env` e configure `TagFilter.1.TagValues.1` como `proc` (prefixo), `proc` (infixo) ou `proc` (exato). Aplique apenas um método de busca por chave de tag (`TagFilter.N.TagKey`). Caso configure múltiplos métodos para a mesma chave, o primeiro prevalecerá. Ao especificar múltiplas chaves de tag, a API retorna apenas os recursos ECS contendo todas as chaves listadas. Se uma chave de tag corresponder a vários valores, todos os recursos ECS que possuírem um ou mais desses pares chave-valor serão incluídos no resultado. Nota Não use o par de parâmetros `TagFilter.N` (TagFilter.N.TagKey e TagFilter.N.TagValues.N) em conjunto com o par `Tag.N` (Tag.N.Key e Tag.N.Value). Caso contrário, uma mensagem de erro será retornada.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
NextToken	String	caeba0bbb2be03f84eb48b699f0a4883	Token necessário para a próxima consulta.
RequestId	String	484256DA-D816-44D2-9D86-B6EE4D5BA78C	ID da solicitação.
TagResources	Array of TagResource		Detalhes sobre os recursos e tags, incluindo IDs de recursos, tipos de recursos e pares chave-valor de tags.
TagResource
TagValue	String	TestValue	Valor da tag do recurso.
ResourceType	String	instance	Tipo do recurso. Valores válidos: instance: instância ECS disk: disco snapshot: snapshot image: imagem securitygroup: grupo de segurança volume: volume de armazenamento eni: ENI ddh: host dedicado ddhcluster: cluster de hosts dedicados keypair: par de chaves SSH launchtemplate: modelo de inicialização reservedinstance: instância reservada snapshotpolicy: política de snapshot automático elasticityassurance: garantia de elasticidade capacityreservation: reserva de capacidade command: comando do Cloud Assistant invocation: resultado da execução de comando do Cloud Assistant
ResourceId	String	i-bp1j6qtvdm8w0z1o****	ID do recurso.
TagKey	String	TestKey	Chave da tag.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

Formato XML

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>

Formato JSON

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidDefaultResourceGroup.NotSupported	The specified parameter Tag is not support for default resource group.	Não é possível consultar o grupo de recursos padrão.
400	InvalidTag.NotSupported	You can only specify Tag for either resource tag or resource group.	Grupos de recursos e tags não podem ser consultados simultaneamente.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	A chave da tag já existe. As chaves de tag devem ser únicas.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	Valor inválido para Tag.N.Key.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	Valor inválido para Tag.N.Value.
400	OperationDenied.QuotaExceed	The quota of tags on resource is beyond permitted range.	O número máximo de tags foi excedido.
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	Os valores de Tag.N.Key e Tag.N.Value não correspondem entre si.
400	InvalidTagCount	The specified tags are beyond the permitted range.	O limite máximo de tags foi ultrapassado.
400	Invalid.Scope	The specified scope is invalid.	Valor inválido para Scope.
403	PermissionDenied.TagOwnerUid	The specified operator not have permission to set TagOwnerUid value.	Você não tem autorização para especificar o parâmetro TagOwnerUid.
403	PermissionDenied.Scope	The specified operator not have permission to set Scope value.	Você não tem autorização para especificar o parâmetro Scope.
403	InvalidResourceId.NotSupported	The specified ResourceId does not support tagging.	O recurso especificado não oferece suporte a tags.
403	NoPermission.Tag	The operator is not permission for the tag.	Você não tem autorização para gerenciar a tag.
404	InvalidRegionId.NotFound	%s	O ID da região especificado não foi encontrado.
404	MissingParameter.ResourceType	The parameter - ResourceType should not be null.	O parâmetro ResourceType é obrigatório.
404	InvalidResourceId.NotFound	The specified ResourceIds are not found in our records.	O ID do recurso especificado não foi encontrado. Verifique se o ID está correto.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.	O tipo de recurso especificado não foi encontrado.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	Valor inválido para RegionId.
500	ServiceUnavailable	The service is unavailable, please try again later.	O serviço está temporariamente indisponível. Tente novamente mais tarde.
500	InternalError	The process of creating snapshot has failed due to some unknown error.	Não foi possível criar o snapshot.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.