ListStackGroups - Resource Orchestration Service: Central de Documentação do Alibaba Cloud

Consulta os detalhes dos grupos de pilhas em uma região do Alibaba Cloud.

Descrição da operação

Este tópico fornece um exemplo para consultar a lista de grupos de pilhas ativos na região China (Hangzhou).

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

ros:ListStackGroups

get

*StackGroup.

acs:ros:{#regionId}:{#accountId}:stackgroup/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do grupo de pilhas. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
Status	string	Não	O status do grupo de pilhas. Se você não especificar este parâmetro, os grupos de pilhas em todos os estados na região serão consultados. Valores válidos: ACTIVE: O grupo de pilhas está ativado. DELETED: O grupo de pilhas foi excluído.	ACTIVE
PageSize	integer	Não	As configurações de paginação para o número de entradas por página em uma consulta paginada. Valores válidos: 1 a 50. Valor padrão: 10.	10
PageNumber	integer	Não	As configurações de paginação para o número da página em uma consulta paginada. Valor mínimo: 1. Valor padrão: 1.	1
ResourceGroupId	string	Não	O ID do grupo de recursos. Se você não especificar este parâmetro, os grupos de pilhas em todos os grupos de recursos serão consultados. Nota Você pode obter o ID do grupo de recursos na página Grupos de recursos no console Gerenciamento de recursos. Para mais informações, consulte Visualizar as informações básicas de um grupo de recursos.	rg-acfmzawhxxcj****
Tags	array<object>	Não	As tags do grupo de pilhas.
	object	Não
Key	string	Sim	A chave da tag do grupo de pilhas. Nota Tags é um parâmetro opcional. Se você especificar Tags, deverá especificar Tags.N.Key.	usage
Value	string	Não	O valor da tag do grupo de pilhas.	test

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
StackGroups	array<object>	Os grupos de pilhas.
	array<object>
StackGroupId	string	O ID do grupo de pilhas.	fd0ddef9-9540-4b42-a464-94f77835****
Status	string	O status do grupo de pilhas. Valores válidos: ACTIVE: O grupo de pilhas está ativado. DELETED: O grupo de pilhas foi excluído.	ACTIVE
DriftDetectionTime	string	A hora em que a última detecção de desvio bem-sucedida foi realizada no grupo de pilhas. A hora está no formato YYYY-MM-DDThh:mm:ss.	2020-02-27T07:47:47
Description	string	A descrição do grupo de pilhas.	My Stack Group
StackGroupDriftStatus	string	O status de desvio do grupo de pilhas na última detecção de desvio bem-sucedida. Valores válidos: DRIFTED: O grupo de pilhas sofreu desvio. NOT_CHECKED: Nenhuma detecção de desvio foi realizada no grupo de pilhas. IN_SYNC: O grupo de pilhas não sofreu desvio.	IN_SYNC
StackGroupName	string	O nome do grupo de pilhas.	MyStackGroup
Tags	array<object>	As tags do grupo de pilhas.
	object
Key	string	A chave da tag do grupo de pilhas.	usage1
Value	string	O valor da tag do grupo de pilhas.	test1
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmzawhxxcj****
PermissionModel	string	O modelo de permissão. Valores válidos: SELF_MANAGED: Permissões autogerenciadas. SERVICE_MANAGED: Permissões gerenciadas pelo serviço. Nota Para mais informações sobre os modelos de permissão de grupos de pilhas, consulte Visão geral.	SELF_MANAGED
AutoDeployment	object	As configurações de implantação automática.
Enabled	boolean	Especifica se a implantação automática deve ser ativada. Valores válidos: true: ativa a implantação automática. Se a implantação automática estiver ativada e uma conta de membro for adicionada à pasta de destino, o grupo de pilhas implantará automaticamente instâncias de pilha nas regiões especificadas da nova conta. Se uma conta for removida da pasta de destino, o grupo de pilhas excluirá as instâncias de pilha das regiões especificadas da conta. false: desativa a implantação automática. Se a implantação automática estiver desativada, as instâncias de pilha não serão alteradas quando as contas de membro na pasta de destino forem alteradas.	true
RetainStacksOnAccountRemoval	boolean	Especifica se as pilhas devem ser retidas nas contas de membro quando as contas de membro forem removidas da pasta de destino. Valores válidos: true: retém as pilhas. false: exclui as pilhas. Nota Este parâmetro é retornado apenas quando Enabled está definido como true.	true
CreateTime	string	A hora em que o grupo de pilhas foi criado. A hora está no formato YYYY-MM-DDThh:mm:ss.	2024-01-05T05:38:31
UpdateTime	string	A hora em que o grupo de pilhas foi atualizado. A hora está no formato YYYY-MM-DDThh:mm:ss.	2024-02-15T16:40:25
TotalCount	integer	O número total de grupos de pilhas.	1
RequestId	string	O ID da solicitação.	14A07460-EBE7-47CA-9757-12CC4761D47A
PageSize	integer	As configurações de paginação para o número de entradas por página em uma consulta paginada.	10
PageNumber	integer	As configurações de paginação para o número da página em uma consulta paginada.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "StackGroups": [
    {
      "StackGroupId": "fd0ddef9-9540-4b42-a464-94f77835****",
      "Status": "ACTIVE",
      "DriftDetectionTime": "2020-02-27T07:47:47",
      "Description": "My Stack Group",
      "StackGroupDriftStatus": "IN_SYNC",
      "StackGroupName": "MyStackGroup",
      "Tags": [
        {
          "Key": "usage1",
          "Value": "test1"
        }
      ],
      "ResourceGroupId": "rg-acfmzawhxxcj****",
      "PermissionModel": "SELF_MANAGED",
      "AutoDeployment": {
        "Enabled": true,
        "RetainStacksOnAccountRemoval": true
      },
      "CreateTime": "2024-01-05T05:38:31",
      "UpdateTime": "2024-02-15T16:40:25"
    }
  ],
  "TotalCount": 1,
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "PageSize": 10,
  "PageNumber": 1
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.