ListTagResources - Tair (Redis® OSS-Compatible): Central de Documentação do Alibaba Cloud

Consulta as tags associadas às instâncias de banco de dados do ApsaraDB for Tair (compatível com Redis® OSS).

Descrição da operação

Para as operações correspondentes no console desta API, consulte Filtrar instâncias por tag e Visualizar tags associadas a uma instância.

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

kvstore:ListTagResources

get

*DBInstance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância.	cn-hangzhou
ResourceType	string	Sim	O tipo de recurso. Defina o valor como INSTANCE. Valores válidos: INSTANCE : Instância.	INSTANCE
NextToken	string	Não	O token usado para iniciar a próxima consulta e retornar mais resultados. Nota Você não precisa fornecer este parâmetro na primeira consulta. Se uma consulta não retornar todos os resultados, você pode passar o valor de NextToken retornado da consulta anterior nas consultas subsequentes para continuar a consulta.	212db86sca4384811e0b5e8707ec2****
ResourceId	array	Não	A lista de IDs de instâncias. Nota Você deve especificar pelo menos um entre este parâmetro e o parâmetro Tag.	r-bp1zxszhcgatnx****
	string	Não	O ID da instância.	r-bp1zxszhcgatnx****
Tag	array<object>	Não	As informações de tag da instância. Você deve especificar pelo menos um entre este parâmetro e o parâmetro ResourceId.
	object	Não
Key	string	Não	A chave da tag.	demokey
Value	string	Não	O valor da tag.	demovalue

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O objeto.
NextToken	string	O token usado para iniciar a próxima consulta. Se uma consulta não retornar todos os resultados, você pode passar o token retornado da consulta anterior nas consultas subsequentes para continuar a consulta.	212db86sca4384811e0b5e8707ec2****
RequestId	string	O ID da solicitação.	47A514A1-4B77-4E30-B4C5-2A880650****
TagResources	object
TagResource	array<object>	As informações sobre as instâncias e tags.
	object	O objeto.
TagValue	string	O valor da tag.	demovalue
ResourceType	string	O tipo de recurso. O valor é fixo como ALIYUN::KVSTORE::INSTANCE, que indica uma instância de banco de dados do ApsaraDB for Tair (compatível com Redis® OSS).	ALIYUN::KVSTORE::INSTANCE
ResourceId	string	O ID do recurso, que é o ID da instância.	r-bp1zxszhcgatnx****
TagKey	string	A chave da tag.	demokey

Exemplos

Resposta de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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.	Os parâmetros Tag e ResourceId não podem estar ambos vazios. Especifique pelo menos um deles.
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 Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.