GetAggregator - Cloud Config: Central de Documentação do Alibaba Cloud

Consulta o nome, a hora de criação, os membros e o tipo de um grupo de contas.

Descrição da operação

Este tópico fornece um exemplo de como consultar os detalhes do grupo de contas ca-88ea626622af0055****. O resultado retornado mostra que o nome do grupo de contas é Test_Group, a descrição do grupo de contas é Test group, o tipo do grupo de contas é CUSTOM (grupo de contas personalizado) e o status do grupo de contas é 1 (criado).

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

config:GetAggregator

get

*Aggregator.

acs:config:*:{#accountId}:aggregator/{#AggregatorId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AggregatorId	string	Sim	O ID do grupo de contas.	ca-88ea626622af0055****
Tag `deprecated`	array<object>	Não	As tags do recurso. Este parâmetro está obsoleto. Ignore este parâmetro porque ele não tem efeito. Um máximo de 20 tags pode ser adicionado.
	object	Não	As tags do recurso. Um máximo de 20 tags pode ser adicionado.
Key	string	Não	A chave da tag do recurso. Um máximo de 20 chaves de tag são suportadas.	key-1
Value	string	Não	O valor da tag do recurso. Um máximo de 20 valores de tag são suportados.	value-1

Para obter mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	733DD93C-2277-4905-AE0C-0BA95C04B8BC
Aggregator	object	As informações do grupo de contas.
AggregatorCreateTimestamp	string	O timestamp de quando o grupo de contas foi criado. Unidade: milissegundos.	1623034091000
AggregatorAccounts	array<object>	As informações sobre os membros no grupo de contas.
	object	As informações dos membros do grupo de contas.
RecorderStatus	string	O status de monitoramento de recursos do membro. Valores válidos: REGISTRABLE: Não registrado. BUILDING: Em construção. REGISTERED: Registrado. REBUILDING: Sendo reconstruído.	REGISTERED
AccountId	integer	O ID do membro.	171322098523****
AccountType	string	A afiliação do membro. Apenas ResourceDirectory (diretório de recursos) é suportado.	ResourceDirectory
AccountName	string	O nome do membro.	Alice
AggregatorAccountCount	integer	O número de membros no grupo de contas.	2
Description	string	A descrição do grupo de contas.	The description of the aggregator
AggregatorName	string	O nome do grupo de contas.	Test_Group
AggregatorStatus	integer	O status do grupo de contas. Valores válidos: 0: Sendo criado. 1: Criado.	1
AggregatorType	string	O tipo do grupo de contas. Valores válidos: RD: grupo de contas global. FOLDER: grupo de contas de pasta de recursos. CUSTOM: grupo de contas personalizado.	CUSTOM
AccountId	integer	O ID da conta de gerenciamento usada para criar o grupo de contas.	100931896542****
AggregatorId	string	O ID do grupo de contas.	ca-88ea626622af0055****
FolderName	string	O nome da pasta de recursos vinculada ao grupo de contas de pasta de recursos. Vários valores são separados por vírgulas (,).	Example-name
Tags	array<object>	As tags do recurso.
	object	As tags do recurso.
TagKey	string	A chave da tag.	key-1
TagValue	string	O valor da tag.	value-1
FolderId	string	O ID da pasta de recursos vinculada ao grupo de contas de pasta de recursos.	fd-brHdgv****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "733DD93C-2277-4905-AE0C-0BA95C04B8BC",
  "Aggregator": {
    "AggregatorCreateTimestamp": "1623034091000",
    "AggregatorAccounts": [
      {
        "RecorderStatus": "REGISTERED",
        "AccountId": 0,
        "AccountType": "ResourceDirectory",
        "AccountName": "Alice"
      }
    ],
    "AggregatorAccountCount": 2,
    "Description": "The description of the aggregator.",
    "AggregatorName": "Test_Group",
    "AggregatorStatus": 1,
    "AggregatorType": "CUSTOM",
    "AccountId": 0,
    "AggregatorId": "ca-88ea626622af0055****",
    "FolderName": "Example-name",
    "Tags": [
      {
        "TagKey": "key-1",
        "TagValue": "value-1"
      }
    ],
    "FolderId": "fd-brHdgv****"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	Invalid.AggregatorId.Value	The specified AggregatorId is invalid.
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.