DescribeTags - Virtual Private Cloud: Central de Documentação do Alibaba Cloud

Consulta uma lista de tags que atendem às condições de filtro especificadas.

Descrição da operação

Especifique pelo menos ResourceId.N ou Tag.N (Tag.N.Key e Tag.N.Value) na solicitação para determinar os objetos a serem consultados.
Tag.N é uma tag de um recurso e consiste em um par chave-valor. Se você especificar apenas Tag.N.Key, todos os valores de tag associados à chave de tag serão retornados. Se você especificar apenas Tag.N.Value, um erro será retornado.
Se você especificar Tag.N e ResourceId.N para filtrar tags, ResourceId.N deve corresponder a qualquer um dos pares chave-valor de tag especificados.
Se você especificar vários pares chave-valor de tag, os resultados conterão todas as tags que correspondem a qualquer um dos pares chave-valor de tag.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

vpc:DescribeTags

get

*All Resource

*

vpc:tag

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ResourceType	string	Não	O tipo de recurso. Valores válidos: VPC: instância de nuvem privada virtual (VPC). VSWITCH: instância de switch virtual. ROUTETABLE: instância de tabela de rotas. EIP: instância de endereço IP elástico (EIP). VPNGATEWAY: instância de gateway VPN. NATGATEWAY: instância de gateway NAT. COMMONBANDWIDTHPACKAGE: instância de Internet Shared Bandwidth. PREFIXLIST: instância de lista de prefixos. PUBLICIPADDRESSPOOL: instância de pool de endereços IP. IPV4GATEWAY: instância de gateway IPv4. IPV6GATEWAY: instância de gateway IPv6. NETWORKACL: instância de ACL de rede. TRAFFICMIRRORFILTER: instância de filtro de espelhamento de tráfego. TRAFFICMIRRORSESSION: instância de sessão de espelhamento de tráfego. FLOWLOG: instância de log de fluxo. HAVIP: instância de endereço IP virtual de alta disponibilidade. DHCPOPTIONSSET: instância de conjunto de opções DHCP. GATEWAYENDPOINT: instância de endpoint de gateway. Nota O valor do tipo de recurso não diferencia maiúsculas de minúsculas.	VPC
RegionId	string	Sim	O ID da região do recurso. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
NextToken	string	Não	O token de paginação. Valores válidos: Se esta for a primeira consulta ou não existir consulta subsequente, deixe este parâmetro vazio. Se existir uma consulta subsequente, defina este parâmetro com o valor NextToken retornado pela chamada de API anterior.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResult	integer	Não	O número de entradas por página. Valores válidos: 1 a 50. Valor padrão: 50.	50
ResourceId	array	Não	O ID do recurso. Você pode especificar até 50 IDs de recurso.
	string	Não	O ID do recurso. Você pode especificar até 50 IDs de recurso. Nota Ao especificar este parâmetro, você também deve especificar o parâmetro ResourceType.	vpc-bp16qjewdsunr41m1****
Tag	array<object>	Não	As tags do recurso.
	object	Não	As tags do recurso.
Key	string	Não	A chave da tag do recurso. Você pode especificar até 20 chaves de tag. Uma chave de tag pode ter até 128 caracteres. Não pode ser uma string vazia nem começar com `aliyun` ou `acs:`, e não pode conter `http://` ou `https://`.	FinanceDept
Value	string	Não	O valor da tag do recurso. Você pode especificar até 20 valores de tag. Um valor de tag pode ter até 128 caracteres. Pode ser uma string vazia, mas não pode começar com `aliyun` ou `acs:`, e não pode conter `http://` ou `https://`.	FinanceJoshua

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Objeto.
NextToken	string	O token de paginação. Valores válidos: Se NextToken estiver vazio, não existe consulta subsequente. Se NextToken for retornado, o valor indica o token para a próxima consulta.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	O ID da solicitação.	C46FF5A8-C5F0-4024-8262-B16B639225A0
TagResources	object
TagResource	array<object>	A lista de todas as tags que atendem às condições de filtro.
	object	A lista de tags.
TagValue	string	The tag value.	FinanceJoshua
TagKey	string	The tag key.	FinanceDept

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "FinanceJoshua",
        "TagKey": "FinanceDept"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	BothEmpty.TagsAndResources	The specified Tags and ResourcesIds are not allow to both empty.	The tags and resource groups cannot be empty at the same time.
400	MissingParameter.TagKey	The input parameter TagKey that is mandatory for processing this request is not supplied.	The TagKey parameter is not set.
400	MissingParameter.TagValue	The input parameter TagValue that is mandatory for processing this request is not supplied.	The TagValue parameter is not set.
400	InvalidTagKey	The tag keys are not valid.	The tag index is invalid.
400	InvalidTagValue	The tag values are not valid.	The tag value is invalid.
400	MissingParam	%s
400	InvalidInstanceType.NotFound	The instance type is not found	The instance type is not found.
400	InvalidInstanceIds.NotFound	The instanceIds are not found	The instance ID is not found.
400	Forbidden.TagKeys	The request do not allow to operate the tag keys	You do not have the permissions to set the TagKeys parameter.
400	QuotaExceeded.TagNum	Custom Tags quota exceeded	The upper limit is reached.
400	Forbidden.NotAllowedCategary	The System tag is not valid	The error message returned because the system tag is invalid.
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	The tag resources are duplicate.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	The number of tags has reached the upper limit.
400	SizeLimitExceeded.ResourceId	The maximum number of resource IDs is exceeded.	The number of resource group IDs has reached the upper limit.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.