Todos os produtos
Search

Este produto

    Resource Orchestration Service:GetStackGroup

    Central de documentação

    Resource Orchestration Service:GetStackGroup

    Última atualização: Oct 12, 2026

    Consulta os detalhes de um grupo de stacks por nome em uma região.

    Descrição da operação

    Este tópico fornece um exemplo para consultar as informações de um grupo de stacks existente chamado MyStackGroup que usa o modelo de permissões autogerenciadas 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:GetStackGroup

    get

    *StackGroup.

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

    		 Nenhuma 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 stacks. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.

    cn-hangzhou
    StackGroupName

    string

    Não

    O nome do grupo de stacks. O nome deve ser exclusivo dentro de uma região.
    O nome pode ter até 255 caracteres e deve começar com um dígito ou uma letra. Pode conter dígitos, letras, hifens (-) e sublinhados (_).

    Nota

    Você deve especificar apenas um dos parâmetros StackGroupName e StackGroupId.

    MyStackGroup
    StackGroupId

    string

    Não

    O ID do grupo de stacks.

    Nota

    Você deve especificar apenas um dos parâmetros StackGroupName e StackGroupId.

    fd0ddef9-9540-4b42-a464-94f77835****

    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

    RequestId

    string

    O ID da solicitação.

    14A07460-EBE7-47CA-9757-12CC4761D47A
    StackGroup

    object

    Os detalhes do grupo de stacks.

    StackGroupId

    string

    O ID do grupo de stacks.

    fd0ddef9-9540-4b42-a464-94f77835****
    Status

    string

    O status do grupo de stacks.

    Valores válidos:

    • ACTIVE: Ativo.

    • DELETED: Excluído.

    ACTIVE
    AdministrationRoleName

    string

    O nome da função de administrador do RAM que o Resource Orchestration Service (ROS) assume quando você cria um grupo de stacks que usa o modelo de permissões autogerenciadas. Se você não especificar este parâmetro, o valor padrão AliyunROSStackGroupAdministrationRole será retornado.

    AliyunROSStackGroupAdministrationRole
    Parameters

    array<object>

    Os parâmetros do grupo de stacks.

    object

    ParameterKey

    string

    O nome do parâmetro.

    Amount
    ParameterValue

    string

    O valor do parâmetro.

    12
    Description

    string

    A descrição do grupo de stacks.

    StackGroup Description
    StackGroupName

    string

    O nome do grupo de stacks.

    MyStackGroup
    ExecutionRoleName

    string

    O nome da função de execução do RAM que a função de administrador (AliyunROSStackGroupAdministrationRole) assume quando você cria um grupo de stacks que usa o modelo de permissões autogerenciadas. Se você não especificar este parâmetro, o valor padrão AliyunROSStackGroupExecutionRole será retornado.

    AliyunROSStackGroupExecutionRole
    TemplateBody

    string

    A estrutura do corpo do modelo.

    Nota

    Este parâmetro de resposta não é recomendado. Use TemplateContent em seu lugar.

    {"ROSTemplateFormatVersion": "2015-09-01"}
    StackGroupDriftDetectionDetail

    object

    Os detalhes da última detecção de desvio bem-sucedida para o grupo de stacks.

    DriftDetectionTime

    string

    A hora em que a detecção de desvio foi realizada no grupo de stacks. A hora está no formato AAAA-MM-DDThh:mm:ss.

    2020-02-27T07:47:47
    TotalStackInstancesCount

    integer

    O número total de instâncias de stack.

    2
    FailedStackInstancesCount

    integer

    O número de instâncias de stack que falharam na detecção de desvio.

    0
    DriftDetectionStatus

    string

    O status de detecção de desvio do grupo de stacks.

    Valores válidos:

    • COMPLETED: A detecção de desvio foi concluída e todas as instâncias de stack concluíram a detecção de desvio com êxito.

    • FAILED: A detecção de desvio foi concluída e o número de instâncias de stack que falharam na detecção de desvio excede o limite especificado.

    • PARTIAL_SUCCESS: A detecção de desvio foi concluída e algumas instâncias de stack falharam na detecção de desvio, mas o número de instâncias com falha não excede o limite.

    • IN_PROGRESS: A detecção de desvio está em andamento.

    • STOPPED: A detecção de desvio foi cancelada pelo usuário.

    COMPLETED
    StackGroupDriftStatus

    string

    O status de desvio do grupo de stacks.

    Valores válidos:

    • DRIFTED: Pelo menos uma instância de stack apresentou desvio.

    • NOT_CHECKED: Nenhuma detecção de desvio bem-sucedida foi realizada no grupo de stacks.

    • IN_SYNC: Todas as instâncias de stack estão sincronizadas.

    DRIFTED
    InProgressStackInstancesCount

    integer

    O número de instâncias de stack para as quais a detecção de desvio está em andamento.

    0
    InSyncStackInstancesCount

    integer

    O número de instâncias de stack que estão sincronizadas.

    1
    CancelledStackInstancesCount

    integer

    O número de instâncias de stack para as quais a detecção de desvio foi cancelada.

    0
    DriftedStackInstancesCount

    integer

    O número de instâncias de stack que apresentaram desvio.

    1
    ResourceGroupId

    string

    O ID do grupo de recursos. O valor depende do ID do grupo de recursos especificado quando o grupo de stacks foi criado.

    rg-acfmxazb4ph6aiy****
    PermissionModel

    string

    O modelo de permissões.

    Valores válidos:

    • SELF_MANAGED: Modelo de permissões autogerenciadas.

    • SERVICE_MANAGED: Modelo de permissões gerenciadas pelo serviço.

    Nota

    Para obter mais informações sobre os modelos de permissões de grupos de stacks, consulte Visão geral.

    SELF_MANAGED
    AutoDeployment

    object

    As configurações de implantação automática.

    Nota

    Este parâmetro é retornado apenas quando PermissionModel está definido como SERVICE_MANAGED.

    Enabled

    boolean

    Especifica se a implantação automática deve ser ativada.

    Valores válidos:

    • true: ativa a implantação automática. Depois que a implantação automática é ativada, se uma conta de membro for adicionada à pasta de destino, o grupo de stacks implanta automaticamente instâncias de stack nas regiões especificadas da nova conta. Se uma conta for removida da pasta de destino, o grupo de stacks exclui as instâncias de stack das regiões especificadas da conta.

    • false: desativa a implantação automática. Depois que a implantação automática é desativada, as instâncias de stack não mudam quando as contas de membro na pasta de destino mudam.

    true
    RetainStacksOnAccountRemoval

    boolean

    Especifica se as stacks devem ser retidas nas contas de membro quando as contas de membro são removidas da pasta de destino.

    Valores válidos:

    • true: retém as stacks.

    • false: exclui as stacks.

    Nota

    Este parâmetro é retornado apenas quando Enabled está definido como true.

    true
    RdFolderIds

    array

    A lista de IDs de pastas de destino no diretório de recursos. As instâncias de stack são implantadas em todas as contas nas pastas.

    Nota

    Este parâmetro é retornado apenas quando PermissionModel está definido como SERVICE_MANAGED.

    string

    A lista de IDs de pastas de destino no diretório de recursos. As instâncias de stack são implantadas em todas as contas nas pastas.

    Nota

    Este parâmetro é retornado apenas quando PermissionModel está definido como SERVICE_MANAGED.

    ["fd-4PvlVLOL8v"]
    TemplateContent

    string

    A estrutura do corpo do modelo no formato JSON. Para obter mais informações, consulte Sintaxe do modelo.

    { "ROSTemplateFormatVersion": "2015-09-01" }
    CreateTime

    string

    A hora em que o grupo de stacks foi criado. A hora está no formato AAAA-MM-DDThh:mm:ss.

    2024-06-14T02:13:50
    UpdateTime

    string

    A hora em que o grupo de stacks foi atualizado. A hora está no formato AAAA-MM-DDThh:mm:ss.

    2024-06-15T02:01:00

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "StackGroup": {
    "StackGroupId": "fd0ddef9-9540-4b42-a464-94f77835****",
    "Status": "ACTIVE",
    "AdministrationRoleName": "AliyunROSStackGroupAdministrationRole",
    "Parameters": [
      {
        "ParameterKey": "Amount",
        "ParameterValue": "12"
      }
    ],
    "Description": "StackGroup Description",
    "StackGroupName": "MyStackGroup",
    "ExecutionRoleName": "AliyunROSStackGroupExecutionRole",
    "TemplateBody": "{\"ROSTemplateFormatVersion\": \"2015-09-01\"}",
    "StackGroupDriftDetectionDetail": {
      "DriftDetectionTime": "2020-02-27T07:47:47",
      "TotalStackInstancesCount": 2,
      "FailedStackInstancesCount": 0,
      "DriftDetectionStatus": "COMPLETED",
      "StackGroupDriftStatus": "DRIFTED",
      "InProgressStackInstancesCount": 0,
      "InSyncStackInstancesCount": 1,
      "CancelledStackInstancesCount": 0,
      "DriftedStackInstancesCount": 1
    },
    "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
    "PermissionModel": "SELF_MANAGED",
    "AutoDeployment": {
      "Enabled": true,
      "RetainStacksOnAccountRemoval": true
    },
    "RdFolderIds": [
      "[\"fd-4PvlVLOL8v\"]"
    ],
    "TemplateContent": "{\n      \"ROSTemplateFormatVersion\": \"2015-09-01\"\n}",
    "CreateTime": "2024-06-14T02:13:50",
    "UpdateTime": "2024-06-15T02:01:00"
  }
}

    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.