DescribeTags - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Consulta todas as tags em uma região especificada.

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

dds:DescribeTags

get

*All Resource

*

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. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
ResourceType	string	Não	O tipo de recurso. Defina o valor como INSTANCE.	INSTANCE
ResourceGroupId	string	Não	O ID do grupo de recursos.	dds-bp17e7a04960****
NextToken	string	Não	O token usado para iniciar a próxima consulta para recuperar mais resultados. Nota Este parâmetro não é obrigatório na primeira consulta. Se nem todos os resultados forem retornados em uma única consulta, você pode passar o valor de NextToken retornado na consulta anterior para realizar a consulta novamente.	212db86****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token usado para iniciar a próxima consulta. Nota Se nem todos os resultados forem retornados na primeira consulta, este parâmetro será retornado. Você pode passar o valor deste parâmetro na próxima consulta.	212db86****
RequestId	string	O ID da solicitação.	EEDBE38F-5CF5-4316-AAC2-35817BA60D68
Tags	array<object>	Detalhes sobre as tags.
	object
TagValues	array	Os valores das tags.	3.4 environment
	string	O valor da tag.	3.4环境
TagKey	string	A chave da tag.	Test group

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "212db86****",
  "RequestId": "EEDBE38F-5CF5-4316-AAC2-35817BA60D68",
  "Tags": [
    {
      "TagValues": [
        "3.4环境"
      ],
      "TagKey": "Test group"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
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.
400	InvalidParameter.Scope	The specified parameter 'Scope' is not valid.
400	NumberExceed.ResourceIds	The ResourceIds parameter's number is exceed.
400	NumberExceed.Tags	The Tags parameter's 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.