Todos os produtos
Search

Este produto

    Resource Orchestration Service:GetStack

    Central de documentação

    Resource Orchestration Service:GetStack

    Última atualização: Jul 04, 2026

    Consulta as informações da pilha.

    Descrição da operação

    Este tópico fornece um exemplo de como consultar as informações de uma pilha cujo ID é c754d2a4-28f1-46df-b557-9586173a**** 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:GetStack

    get

    *stack

    acs:ros:{#regionId}:{#accountId}:stack/{#stackId}

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    StackId

    string

    Sim

    O ID da pilha.

    c754d2a4-28f1-46df-b557-9586173a****
    RegionId

    string

    Sim

    O ID da região da pilha. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.

    cn-hangzhou
    ClientToken

    string

    Não

    O token do cliente usado para garantir a idempotência da solicitação. O token é gerado pelo cliente e deve ser globalmente único.\nO token pode ter até 64 caracteres.\nPara mais informações, consulte Como garantir a idempotência.

    123e4567-e89b-12d3-a456-42665544****
    OutputOption

    string

    Não

    Especifica se deve retornar o parâmetro Outputs (a lista de saídas da pilha). Valores válidos:\n\n- Enabled (padrão): Retorna o parâmetro Outputs.\n\n- Disabled: Não retorna o parâmetro Outputs.\n> O cálculo de Outputs consome tempo. Se você não precisar das informações de Outputs, defina OutputOption como Disabled para melhorar a velocidade de resposta da API.

    Disabled
    ShowResourceProgress

    string

    Não

    Especifica se deve retornar o parâmetro ResourceProgress (progresso do processamento de recursos). Valores válidos:\n\n- Disabled (padrão): Não retorna o parâmetro ResourceProgress.\n\n- PercentageOnly: Retorna os parâmetros StackOperationProgress e StackActionProgress em ResourceProgress.\n\n> Há suporte para pilhas ROS e pilhas Terraform. Há suporte para criação de pilha (incluindo criação continuada), atualização, exclusão, importação de recursos e operações de reversão correspondentes.\n\n- EnabledIfCreateStack (não recomendado): Retorna os parâmetros *Count e InProgressResourceDetails em ResourceProgress apenas durante a criação da pilha.\n> Durante a criação da pilha, o status da pilha é CREATE_IN_PROGRESS, CREATE_COMPLETE, CREATE_FAILED, CREATE_ROLLBACK_IN_PROGRESS, CREATE_ROLLBACK_COMPLETE ou CREATE_ROLLBACK_FAILED.

    Disabled
    LogOption

    string

    Não

    A opção de log. Valores válidos:\n- None: Não retorna logs.\n- Stack (padrão): Retorna logs relacionados à pilha.\n- Resource: Retorna logs relacionados a recursos.\n- All: Retorna todos os logs.

    Stack

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

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Status

    string

    O status da pilha. Valores válidos:\n- CREATE_IN_PROGRESS: A pilha está sendo criada.\n- CREATE_FAILED: Falha ao criar a pilha.\n- CREATE_COMPLETE: A pilha foi criada.\n- UPDATE_IN_PROGRESS: A pilha está sendo atualizada.\n- UPDATE_FAILED: Falha ao atualizar a pilha.\n- UPDATE_COMPLETE: A pilha foi atualizada.\n- DELETE_IN_PROGRESS: A pilha está sendo excluída.\n- DELETE_FAILED: Falha ao excluir a pilha.\n- DELETE_COMPLETE: A pilha foi excluída.\n- CREATE_ROLLBACK_IN_PROGRESS: A criação da pilha está sendo revertida.\n- CREATE_ROLLBACK_FAILED: Falha ao reverter a criação da pilha.\n- CREATE_ROLLBACK_COMPLETE: A criação da pilha foi revertida.\n- ROLLBACK_IN_PROGRESS: A pilha está sendo revertida.\n- ROLLBACK_FAILED: Falha ao reverter a pilha.\n- ROLLBACK_COMPLETE: A pilha foi revertida.\n- CHECK_IN_PROGRESS: A pilha está sendo validada.\n- CHECK_FAILED: Falha ao validar a pilha.\n- CHECK_COMPLETE: A pilha foi validada.\n- REVIEW_IN_PROGRESS: A pilha está sendo revisada.\n- IMPORT_CREATE_IN_PROGRESS: A pilha está sendo criada por meio de importação de recursos.\n- IMPORT_CREATE_FAILED: Falha ao criar a pilha por meio de importação de recursos.\n- IMPORT_CREATE_COMPLETE: A pilha foi criada por meio de importação de recursos.\n- IMPORT_CREATE_ROLLBACK_IN_PROGRESS: A criação da pilha por meio de importação de recursos está sendo revertida.\n- IMPORT_CREATE_ROLLBACK_FAILED: Falha ao reverter a criação da pilha por meio de importação de recursos.\n- IMPORT_CREATE_ROLLBACK_COMPLETE: A criação da pilha por meio de importação de recursos foi revertida.\n- IMPORT_UPDATE_IN_PROGRESS: A pilha está sendo atualizada por meio de importação de recursos.\n- IMPORT_UPDATE_FAILED: Falha ao atualizar a pilha por meio de importação de recursos.\n- IMPORT_UPDATE_COMPLETE: A pilha foi atualizada por meio de importação de recursos.\n- IMPORT_UPDATE_ROLLBACK_IN_PROGRESS: A atualização da pilha por meio de importação de recursos está sendo revertida.\n- IMPORT_UPDATE_ROLLBACK_FAILED: Falha ao reverter a atualização da pilha por meio de importação de recursos.\n- IMPORT_UPDATE_ROLLBACK_COMPLETE: A atualização da pilha por meio de importação de recursos foi revertida.

    CREATE_COMPLETE
    Description

    string

    A descrição da pilha.

    Create a VPC.
    Parameters

    array<object>

    Os parâmetros da pilha.

    object

    ParameterKey

    string

    O nome do parâmetro.

    ALIYUN::Region
    ParameterValue

    string

    O valor do parâmetro.

    cn-hangzhou
    RequestId

    string

    O ID da solicitação.

    B288A0BE-D927-4888-B0F7-B35EF84B6E6F
    StatusReason

    string

    O motivo pelo qual a pilha está em seu estado atual.

    Stack CREATE completed successfully
    ParentStackId

    string

    O ID da pilha pai.

    4a6c9851-3b0f-4f5f-b4ca-a14bf692****
    CreateTime

    string

    A hora em que a pilha foi criada. A hora é exibida em UTC+0 e segue o padrão ISO 8601 sem o Z no final. Formato: AAAA-MM-DDThh:mm:ss.

    2020-09-16T08:21:40
    DeletionProtection

    string

    Indica se a proteção contra exclusão está ativada para a pilha. Valores válidos:\n- Enabled: A proteção contra exclusão está ativada.\n- Disabled: A proteção contra exclusão está desativada. Nesse caso, você pode liberar a pilha usando o console ou chamando a operação DeleteStack.\n\n> O mecanismo de proteção contra exclusão de uma pilha aninhada é o mesmo da pilha raiz.

    Disabled
    RootStackId

    string

    O ID da pilha raiz. Este parâmetro é retornado apenas quando a pilha é uma pilha aninhada.

    4a6c9851-3b0f-4f5f-b4ca-a14bf692****
    TemplateDescription

    string

    A descrição do modelo.

    Create a VPC.
    StackType

    string

    O tipo de pilha. Valores válidos:\n- ROS: A pilha usa um modelo ROS.\n- Terraform: A pilha usa um modelo Terraform.

    ROS
    RamRoleName

    string

    O nome da função RAM. O Resource Orchestration Service (ROS) assume essa função para criar a pilha e chama operações de API em nome do usuário usando as credenciais da função.\nO ROS sempre usa essa função para todas as operações realizadas na pilha. Desde que o usuário tenha permissão para realizar operações na pilha, o ROS usa essa função mesmo que o usuário não tenha permissão para usá-la. Isso garante que a função conceda o menor privilégio possível.\nSe nenhum valor for especificado, o ROS usa a função que foi associada anteriormente à pilha. Se nenhuma função estiver disponível, o ROS usa uma credencial temporária gerada a partir das credenciais do usuário.\nO nome da função RAM pode ter até 64 bytes.

    test-role
    UpdateTime

    string

    A hora em que a pilha foi atualizada pela última vez. A hora é exibida em UTC+0 e segue o padrão ISO 8601 sem o Z no final. Formato: AAAA-MM-DDThh:mm:ss.

    2020-09-17T08:21:40
    Outputs

    array<object>

    A lista de saídas da pilha.

    object

    A lista de saídas da pilha.\n\n> Este parâmetro é retornado apenas quando OutputOption está definido como Enabled.

    [{"Description": "VPC ID","OutputKey": "VpcId","OutputValue": "vpc-bp1m6fww66xbntjyc****"}]
    DriftDetectionTime

    string

    A hora em que a detecção de desvio bem-sucedida mais recente foi realizada na pilha.

    2020-09-16T09:21:40
    RegionId

    string

    O ID da região da pilha. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.

    cn-hangzhou
    StackDriftStatus

    string

    O status de desvio da pilha na detecção de desvio bem-sucedida mais recente. Valores válidos:\n- DRIFTED: A pilha sofreu desvio.\n- NOT_CHECKED: Nenhuma detecção de desvio bem-sucedida foi realizada na pilha.\n- IN_SYNC: A pilha está sincronizada.

    IN_SYNC
    NotificationURLs

    array

    As URLs de callback para recebimento de eventos da pilha.

    string

    As URLs de callback para recebimento de eventos da pilha.

    ["http://127.XX.XX.1:8080/x", "http://127.0.XX.XX:8080/y"]
    DisableRollback

    boolean

    Indica se a reversão está desativada quando há falha na criação da pilha. Valores válidos:\n\n- true: A reversão está desativada. Nenhuma reversão é realizada quando há falha na criação da pilha.\n- false (padrão): A reversão está ativada. A reversão é realizada quando há falha na criação da pilha.

    false
    StackName

    string

    O nome da pilha.\nO nome pode ter até 255 caracteres e deve começar com um dígito ou letra. Pode conter dígitos, letras, hifens (-) e sublinhados (_).

    MyStack
    Tags

    array<object>

    As tags da pilha.

    object

    Key

    string

    A chave da tag da pilha.

    usage
    Value

    string

    O valor da tag da pilha.

    test
    TimeoutInMinutes

    integer

    O período de tempo limite para a criação da pilha. Unidade: minutos.

    10
    StackId

    string

    O ID da pilha.

    c754d2a4-28f1-46df-b557-9586173a****
    ResourceGroupId

    string

    O ID do grupo de recursos.

    rg-acfmxazb4ph6aiy****
    ResourceProgress

    object

    O progresso do processamento de recursos.

    TotalResourceCount

    integer

    O número total de recursos.\n\n> Este parâmetro é retornado apenas quando ShowResourceProgress está definido como EnabledIfCreateStack.

    2
    SuccessResourceCount

    integer

    O número de recursos processados com êxito.\n\n> Este parâmetro é retornado apenas quando ShowResourceProgress está definido como EnabledIfCreateStack.

    1
    FailedResourceCount

    integer

    O número de recursos que falharam ao serem processados.\n\n> Este parâmetro é retornado apenas quando ShowResourceProgress está definido como EnabledIfCreateStack.

    0
    InProgressResourceCount

    integer

    O número de recursos que estão sendo processados.\n\n> Este parâmetro é retornado apenas quando ShowResourceProgress está definido como EnabledIfCreateStack.

    1
    PendingResourceCount

    integer

    O número de recursos com processamento pendente.\n\n> Este parâmetro é retornado apenas quando ShowResourceProgress está definido como EnabledIfCreateStack.

    0
    InProgressResourceDetails

    array<object>

    A lista de detalhes de progresso para recursos que estão sendo processados.\n\n> Este parâmetro é retornado apenas quando ShowResourceProgress está definido como EnabledIfCreateStack.

    object

    Os detalhes de progresso de um recurso que está sendo processado.

    ResourceName

    string

    The resource name.

    WaitCondition
    ResourceType

    string

    The resource type.

    ALIYUN::ROS::WaitCondition
    ProgressValue

    number

    The current progress value of the resource.

    5
    ProgressTargetValue

    number

    The target progress value of the resource.

    10
    StackOperationProgress

    number

    A porcentagem de progresso da operação da pilha. Intervalo de valores: 0 a 100.\n\nExemplo: Durante a criação da pilha, o valor começa em 0 e aumenta. Se a criação for bem-sucedida, o valor atinge 100. Se a criação falhar e a reversão começar, o valor diminui. Quando a reversão for bem-sucedida, o valor atinge 0. Este parâmetro indica o progresso geral da operação de criação, independentemente de o status da pilha ser de criação ou reversão.\n\n> Este parâmetro é retornado apenas quando ShowResourceProgress está definido como PercentageOnly.

    100
    StackActionProgress

    number

    A porcentagem de progresso da ação da pilha. Intervalo de valores: 0 a 100.\n\nExemplo: Durante a criação da pilha, o valor começa em 0 e aumenta. Se a criação for bem-sucedida, o valor atinge 100. Se a criação falhar e a reversão começar, o valor começa a partir de outro valor (100 menos o valor de progresso quando a criação do recurso falhou) e aumenta. Quando a reversão for bem-sucedida, o valor atinge 100. Durante a criação da pilha, este parâmetro indica o progresso da ação de criação. Durante a reversão da pilha, este parâmetro indica o progresso da ação de reversão.\n\n> Este parâmetro é retornado apenas quando ShowResourceProgress está definido como PercentageOnly.

    100
    Log

    object

    Os logs de saída relacionados à pilha.

    TerraformLogs

    array<object>

    Os logs de saída do Terraform. Este parâmetro é retornado apenas para pilhas Terraform.\nEste parâmetro é retornado quando LogOption não é especificado, ou quando LogOption está definido como Stack ou All.\n\n> Este parâmetro não é retornado para pilhas em execução. Este parâmetro indica os logs da operação mais recente (criação, criação continuada, atualização ou exclusão) na pilha.

    object

    teste.

    Command

    string

    The name of the Terraform command that is run. Valid values:

    • apply

    • plan

    • destroy

    • version

    For more information about the commands, see Command.

    apply
    Stream

    string

    The output stream. Valid values:

    • stdout: standard output.

    • stderr: standard error.

    stdout
    Content

    string

    The content that is output by the current command in the current output stream.

    Apply complete! Resources: 42 added, 0 changed, 0 destroyed.
    ResourceLogs

    array<object>

    Os logs de saída de recursos. Este parâmetro é retornado quando LogOption está definido como Resource ou All.\n\n> Apenas alguns tipos de recursos retornam logs de recursos, como ALIYUN::ROS::ResourceCleaner.

    array<object>

    teste.

    ResourceName

    string

    The resource name defined in the template.

    MyResourceCleaner
    Logs

    array<object>

    All logs associated with the resource.

    object

    test

    Keys

    array

    The list of keywords for a log entry associated with the resource.

    string

    The keyword.

    ResourceDetails
    Content

    string

    The content of a log entry associated with the resource.

    []
    TemplateId

    string

    O ID do modelo. Este parâmetro é retornado apenas quando o modelo usado pela pilha é um modelo privado ou um modelo compartilhado.\n\nSe o modelo for um modelo compartilhado, o valor retornado será o mesmo que o TemplateARN do modelo.

    a52f81be-496f-4e1c-a286-8852ab54****
    TemplateVersion

    string

    A versão do modelo. Este parâmetro é retornado apenas quando o modelo usado pela pilha é um modelo privado ou um modelo compartilhado.\n\nSe o modelo for um modelo compartilhado, este parâmetro será retornado apenas quando VersionOption estiver definido como AllVersions durante o compartilhamento.\n\nValores válidos: v1 a v100.

    v1
    TemplateScratchId

    string

    O ID do cenário de recursos. Este parâmetro é retornado apenas quando o modelo usado pela pilha é gerado a partir de um cenário de recursos.

    ts-7f7a704cf71c49a6****
    TemplateURL

    string

    A URL do arquivo que contém o corpo do modelo. Este parâmetro é retornado apenas quando o modelo usado pela pilha proviene de uma URL, incluindo um servidor web (HTTP ou HTTPS) ou um bucket do Alibaba Cloud OSS.

    oss://ros/template/demo
    Interface

    string

    A descrição da interface.

    {}
    ServiceManaged

    boolean

    Indica se a pilha é uma pilha gerenciada. Valores válidos:\n\n- true: A pilha é uma pilha gerenciada.\n\n- false: A pilha não é uma pilha gerenciada.

    false
    ServiceName

    string

    O nome do serviço ao qual a pilha gerenciada pertence.

    ACVS
    OperationInfo

    object

    As informações suplementares que são retornadas quando ocorre um erro durante uma operação de pilha.\n\n> Esta propriedade é retornada apenas em casos específicos e contém pelo menos uma subpropriedade. Por exemplo, quando ocorre um erro ao chamar a API de outro serviço de nuvem.

    Code

    string

    O código de erro.

    DependencyViolation
    Message

    string

    A mensagem de erro.

    There is still instance(s) in the specified security group.
    RequestId

    string

    O ID da solicitação da chamada de API para outro serviço de nuvem.

    071D6166-3F6B-5C7B-A1F0-0113FBB643A8
    Action

    string

    O nome da operação de API chamada em outro serviço de nuvem.

    DeleteSecurityGroup
    ResourceType

    string

    O tipo de recurso no qual o erro de operação ocorreu.

    ALIYUN::ECS::SecurityGroup
    LogicalResourceId

    string

    O ID lógico do recurso no qual o erro de operação ocorreu.

    EcsSecurityGroup
    OrderIds

    array

    A lista de IDs de pedido. Este parâmetro é retornado apenas quando o pagamento manual para pedidos de assinatura é configurado durante a criação da pilha.

    string

    O ID do pedido.

    2161413696****
    CheckedStackResourceCount

    integer

    O número de recursos nos quais a detecção de desvio foi realizada.\n> Este parâmetro é retornado apenas quando a detecção de desvio mais recente na pilha foi bem-sucedida.

    1
    NotCheckedStackResourceCount

    integer

    O número de recursos nos quais a detecção de desvio não foi realizada.\n> Este parâmetro é retornado apenas quando a detecção de desvio mais recente na pilha foi bem-sucedida.

    1
    RollbackFailedRootReason

    string

    Quando o status da pilha é de falha na reversão, este campo exibe a causa raiz da falha na fase anterior que acionou a reversão.

    Resource UPDATE failed: Exception: resources.FailToCreate: FailToCreate: reason

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "Status": "CREATE_COMPLETE",
  "Description": "Create a VPC.",
  "Parameters": [
    {
      "ParameterKey": "ALIYUN::Region",
      "ParameterValue": "cn-hangzhou"
    }
  ],
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
  "StatusReason": "Stack CREATE completed successfully",
  "ParentStackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
  "CreateTime": "2020-09-16T08:21:40",
  "DeletionProtection": "Disabled",
  "RootStackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
  "TemplateDescription": "Create a VPC.",
  "StackType": "ROS",
  "RamRoleName": "test-role",
  "UpdateTime": "2020-09-17T08:21:40",
  "Outputs": [
    [
      {
        "Description": "VPC ID",
        "OutputKey": "VpcId",
        "OutputValue": "vpc-bp1m6fww66xbntjyc****"
      }
    ]
  ],
  "DriftDetectionTime": "2020-09-16T09:21:40",
  "RegionId": "cn-hangzhou",
  "StackDriftStatus": "IN_SYNC",
  "NotificationURLs": [
    "[\"http://127.XX.XX.1:8080/x\", \"http://127.0.XX.XX:8080/y\"]"
  ],
  "DisableRollback": false,
  "StackName": "MyStack",
  "Tags": [
    {
      "Key": "usage",
      "Value": "test"
    }
  ],
  "TimeoutInMinutes": 10,
  "StackId": "c754d2a4-28f1-46df-b557-9586173a****",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "ResourceProgress": {
    "TotalResourceCount": 2,
    "SuccessResourceCount": 1,
    "FailedResourceCount": 0,
    "InProgressResourceCount": 1,
    "PendingResourceCount": 0,
    "InProgressResourceDetails": [
      {
        "ResourceName": "WaitCondition",
        "ResourceType": "ALIYUN::ROS::WaitCondition",
        "ProgressValue": 5,
        "ProgressTargetValue": 10
      }
    ],
    "StackOperationProgress": 100,
    "StackActionProgress": 100
  },
  "Log": {
    "TerraformLogs": [
      {
        "Command": "apply",
        "Stream": "stdout",
        "Content": "Apply complete! Resources: 42 added, 0 changed, 0 destroyed."
      }
    ],
    "ResourceLogs": [
      {
        "ResourceName": "MyResourceCleaner",
        "Logs": [
          {
            "Keys": [
              "ResourceDetails"
            ],
            "Content": "[]"
          }
        ]
      }
    ]
  },
  "TemplateId": "a52f81be-496f-4e1c-a286-8852ab54****",
  "TemplateVersion": "v1",
  "TemplateScratchId": "ts-7f7a704cf71c49a6****",
  "TemplateURL": "oss://ros/template/demo",
  "Interface": "{}",
  "ServiceManaged": false,
  "ServiceName": "ACVS",
  "OperationInfo": {
    "Code": "DependencyViolation",
    "Message": "There is still instance(s) in the specified security group.",
    "RequestId": "071D6166-3F6B-5C7B-A1F0-0113FBB643A8",
    "Action": "DeleteSecurityGroup",
    "ResourceType": "ALIYUN::ECS::SecurityGroup",
    "LogicalResourceId": "EcsSecurityGroup"
  },
  "OrderIds": [
    "2161413696****"
  ],
  "CheckedStackResourceCount": 1,
  "NotCheckedStackResourceCount": 1,
  "RollbackFailedRootReason": "Resource UPDATE failed: Exception: resources.FailToCreate: FailToCreate: reason"
}

    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.