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

Consulta as chaves 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:DescribeTagKeys

get

*All Resource

*

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: virtual private cloud (VPC) VSWITCH: vSwitch ROUTETABLE: tabela de rotas EIP: endereço elastic IP (EIP) VpnGateway: gateway VPN NATGATEWAY: gateway NAT COMMONBANDWIDTHPACKAGE: pacote de largura de banda de EIP	VPC
Keyword	string	Não	As chaves de tag.	keyword
RegionId	string	Sim	O ID da região do recurso. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
NextToken	string	Não	O token usado para a próxima consulta. Valores válidos: Se esta for sua primeira consulta ou se nenhuma consulta subsequente for enviada, ignore este parâmetro. Se uma consulta subsequente for enviada, defina o parâmetro com o valor de NextToken retornado na última chamada.	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	Os IDs dos recursos. Você pode especificar até 20 IDs de recursos.
	string	Não	O ID do recurso. Você pode inserir no máximo 50 IDs. Nota Se você definir este parâmetro, deverá definir ResourceType.	vpc-bp16qjewdsunr41m1****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Objeto.
NextToken	string	O token usado para a próxima consulta. Valores válidos: Se o valor de NextToken não for retornado, indica que nenhuma consulta subsequente será enviada. Se um valor de NextToken for retornado, o valor é o token usado para a consulta subsequente.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	O ID da solicitação.	DE65F6B7-7566-4802-9007-96F2494AC512
TagKeys	object
TagKey	array<object>	A lista de chaves de tag.
	object
Type	string	The type of the tag key. Valid values: Custom: custom System: system	Custom
TagKey	string	The tag key.	FinanceDept

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "DE65F6B7-7566-4802-9007-96F2494AC512",
  "TagKeys": {
    "TagKey": [
      {
        "Type": "Custom",
        "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.