全部產品
Search

搜尋本產品

    Resource Orchestration Service：GetStack - 查詢資源棧資訊

    文件中心

    Resource Orchestration Service：GetStack - 查詢資源棧資訊

    更新時間：Dec 15, 2025

    查詢資源棧資訊。

    介面說明

    本文將提供一個樣本，查詢杭州地區 ID 為c754d2a4-28f1-46df-b557-9586173a****的資源棧資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ros:GetStack

    get

    *stack

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    StackId

    string

    是

    資源棧 ID。

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

    string

    是

    資源棧所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。

    cn-hangzhou
    ClientToken

    string

    否

    保證請求的等冪性。 該值由用戶端產生，並且必須全域唯一。
    長度不超過 64 個字元。
    更多資訊，請參見如何保證等冪性。

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

    string

    否

    是否返回 Outputs 參數（資源棧輸出資料行表）。取值：

    • Enabled（預設值）：返回 Outputs 參數。

    • Disabled：不返回 Outputs 參數。

    說明

    Outputs 計算較為耗時。如果不需要擷取 Outputs 資訊，建議您將 OutputOption 指定為 Disabled，提高介面響應速度。

    Disabled
    ShowResourceProgress

    string

    否

    是否返回 ResourceProgress 參數（資源處理進度）。取值：

    • Disabled（預設值）：不返回 ResourceProgress 參數。

    • PercentageOnly：返回 ResourceProgress 中 StackOperationProgress 和 StackActionProgress 參數。

    說明

    支援 ROS 類型和 Terraform 類型資源棧。支援資源棧建立（含繼續建立）、更新、刪除、匯入及相應的復原操作。

    • EnabledIfCreateStack（不推薦）：僅在建立資源棧時返回 ResourceProgress 中*Count 和 InProgressResourceDetails 參數。

    說明

    建立資源棧時資源棧狀態為 CREATE_IN_PROGRESS、CREATE_COMPLETE、CREATE_FAILED、CREATE_ROLLBACK_IN_PROGRESS、CREATE_ROLLBACK_COMPLETE 或 CREATE_ROLLBACK_FAILED。

    Disabled
    LogOption

    string

    否

    日誌選項。取值：

    • None：不返回日誌。

    • Stack（預設值）：返回資源棧相關日誌。

    • Resource：返回資源相關日誌。

    • All：返回所有日誌。

    Stack

    關於公用請求參數的詳情，請參見公用參數。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Status

    string

    資源棧狀態。取值：

    • CREATE_IN_PROGRESS：資源棧建立中。

    • CREATE_FAILED：資源棧建立失敗。

    • CREATE_COMPLETE：資源棧建立成功。

    • UPDATE_IN_PROGRESS：資源棧更新中。

    • UPDATE_FAILED：資源棧更新失敗。

    • UPDATE_COMPLETE：資源棧更新成功。

    • DELETE_IN_PROGRESS：資源棧刪除中。

    • DELETE_FAILED：資源棧刪除失敗。

    • DELETE_COMPLETE：資源棧刪除成功。

    • CREATE_ROLLBACK_IN_PROGRESS：建立資源棧復原中。

    • CREATE_ROLLBACK_FAILED：建立資源棧復原失敗。

    • CREATE_ROLLBACK_COMPLETE：建立資源棧復原成功。

    • ROLLBACK_IN_PROGRESS：資源棧復原中。

    • ROLLBACK_FAILED：資源棧復原失敗。

    • ROLLBACK_COMPLETE：資源棧復原成功。

    • CHECK_IN_PROGRESS：資源棧校正中。

    • CHECK_FAILED：資源棧校正失敗。

    • CHECK_COMPLETE：資源棧校正成功。

    • REVIEW_IN_PROGRESS：資源棧核對中。

    • IMPORT_CREATE_IN_PROGRESS：通過資源匯入建立資源棧中。

    • IMPORT_CREATE_FAILED：通過資源匯入建立資源棧失敗。

    • IMPORT_CREATE_COMPLETE：通過資源匯入建立資源棧成功。

    • IMPORT_CREATE_ROLLBACK_IN_PROGRESS：通過資源匯入建立資源棧復原中。

    • IMPORT_CREATE_ROLLBACK_FAILED：通過資源匯入建立資源棧復原失敗。

    • IMPORT_CREATE_ROLLBACK_COMPLETE：通過資源匯入建立資源棧復原成功。

    • IMPORT_UPDATE_IN_PROGRESS：通過資源匯入更新資源棧中。

    • IMPORT_UPDATE_FAILED：通過資源匯入更新資源棧失敗。

    • IMPORT_UPDATE_COMPLETE：通過資源匯入更新資源棧成功。

    • IMPORT_UPDATE_ROLLBACK_IN_PROGRESS：通過資源匯入更新資源棧復原中。

    • IMPORT_UPDATE_ROLLBACK_FAILED：通過資源匯入更新資源棧復原失敗。

    • IMPORT_UPDATE_ROLLBACK_COMPLETE：通過資源匯入更新資源棧復原成功。

    CREATE_COMPLETE
    Description

    string

    資源棧的描述資訊。

    Create a VPC.
    Parameters

    array<object>

    資源棧參數。

    object

    ParameterKey

    string

    參數名稱。

    ALIYUN::Region
    ParameterValue

    string

    參數值。

    cn-hangzhou
    RequestId

    string

    請求 ID。

    B288A0BE-D927-4888-B0F7-B35EF84B6E6F
    StatusReason

    string

    資源棧狀態說明。

    Stack CREATE completed successfully
    ParentStackId

    string

    父資源棧 ID。

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

    string

    資源棧建立時間。按照 ISO8601 標準表示，需使用 UTC 時間，格式：YYYY-MM-DDThh:mm:ss。

    2020-09-16T08:21:40
    DeletionProtection

    string

    是否開啟資源棧刪除保護。取值：

    • Enabled：開啟資源棧刪除保護。

    • Disabled：關閉資源棧刪除保護。此時支援通過控制台或 API（DeleteStack）釋放資源棧。

    說明

    嵌套資源棧的刪除保護機制與根資源棧一致。

    Disabled
    RootStackId

    string

    根資源棧 ID。當資源棧為嵌套資源棧時，會返回該參數。

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

    string

    模板描述。

    Create a VPC.
    StackType

    string

    資源棧類型。取值：

    • ROS：使用 ROS 模板的資源棧。

    • Terraform：使用 Terraform 模板的資源棧。

    ROS
    RamRoleName

    string

    RAM 角色名稱。ROS 會扮演該角色建立資源棧，使用角色的憑證代表使用者進行介面調用。
    ROS 始終將此角色用於資源棧上將進行的操作。只要使用者有權在資源棧上進行操作，即使使用者無權使用角色，ROS 也會使用此角色，確保角色授予最少的許可權。
    如果使用者未指定該值，ROS 將使用以前與資源棧關聯的角色。如果沒有可用角色，ROS 將使用從您的使用者憑證中產生的臨時憑證。
    RAM 角色名稱最大長度為 64 個位元組。

    test-role
    UpdateTime

    string

    資源棧更新時間。按照 ISO8601 標準表示，需使用 UTC 時間，格式：YYYY-MM-DDThh:mm:ss。

    2020-09-17T08:21:40
    Outputs

    array<object>

    資源棧輸出資料行表。

    object

    資源棧輸出資料行表。

    說明

    當 OutputOption 取值為 Enabled 時返回該參數。

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

    string

    資源棧最近一次成功的偏差檢測的時間。

    2020-09-16T09:21:40
    RegionId

    string

    要建立的資源棧所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。

    cn-hangzhou
    StackDriftStatus

    string

    資源棧最近一次成功的偏差檢測中的資源棧的狀態。取值：

    • DRIFTED：資源棧處於偏差狀態。

    • NOT_CHECKED：資源棧未進行過成功的偏差檢測。

    • IN_SYNC：資源棧處於同步狀態。

    IN_SYNC
    NotificationURLs

    array

    接收資源棧事件的 URL 回調地址。

    string

    接收資源棧事件的 URL 回調地址。

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

    boolean

    當建立資源棧失敗時，是否禁用復原策略。取值：

    • true：禁用復原，即當建立資源棧失敗時不進行復原。

    • false（預設值）：不禁用復原，即當建立資源棧失敗時進行復原。

    false
    StackName

    string

    資源棧名稱。
    長度不超過 255 個字元，必須以數字或英文字母開頭，可包含數字、英文字母、短劃線（-）和底線（_）。

    MyStack
    Tags

    array<object>

    資源棧的標籤。

    object

    Key

    string

    資源棧的標籤鍵。

    usage
    Value

    string

    資源棧的標籤值。

    test
    TimeoutInMinutes

    integer

    建立資源棧的逾時時間。單位：分鐘。

    10
    StackId

    string

    資源棧 ID。

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

    string

    資源群組 ID。

    rg-acfmxazb4ph6aiy****
    ResourceProgress

    object

    資源處理進度。

    TotalResourceCount

    integer

    總資源數。

    說明

    僅在ShowResourceProgress參數取值為EnabledIfCreateStack時返回。

    2
    SuccessResourceCount

    integer

    處理成功的資源數。

    說明

    僅在ShowResourceProgress參數取值為EnabledIfCreateStack時返回。

    1
    FailedResourceCount

    integer

    處理失敗的資源數。

    說明

    僅在ShowResourceProgress參數取值為EnabledIfCreateStack時返回。

    0
    InProgressResourceCount

    integer

    處理中的資源數。

    說明

    僅在ShowResourceProgress參數取值為EnabledIfCreateStack時返回。

    1
    PendingResourceCount

    integer

    待處理的資源數。

    說明

    僅在ShowResourceProgress參數取值為EnabledIfCreateStack時返回。

    0
    InProgressResourceDetails

    array<object>

    處理中的資源進度詳情列表。

    說明

    僅在ShowResourceProgress參數取值為EnabledIfCreateStack時返回。

    object

    處理中的資源進度詳情。

    ResourceName

    string

    資源名稱。

    WaitCondition
    ResourceType

    string

    資源類型。

    ALIYUN::ROS::WaitCondition
    ProgressValue

    number

    資源進度當前值。

    5
    ProgressTargetValue

    number

    資源進度目標值。

    10
    StackOperationProgress

    number

    資源棧操作進度百分比。取值範圍：0-100。

    樣本說明：建立資源棧時，取值從 0 開始一直在增加。如果建立成功，取值達到 100。如果建立失敗，開始復原，則取值一直在減少。復原成功時，取值達到 0。該參數表示這次建立操作的整體進度，無論資源棧狀態是建立中還是復原中。

    說明

    僅在ShowResourceProgress參數取值為PercentageOnly時返回。

    100
    StackActionProgress

    number

    資源棧動作進度百分比。取值範圍：0-100。

    樣本說明：建立資源棧時，取值從 0 開始一直在增加。如果建立成功，取值達到 100。如果建立失敗，開始復原，則取值從另一個值（100-資源建立失敗時的進度值）開始一直在增加。復原成功時，取值達到 100。該參數在建立資源棧時，表示建立動作的進度，在資源棧復原時，表示復原動作的進度。

    說明

    僅在ShowResourceProgress參數取值為PercentageOnly時返回。

    100
    Log

    object

    資源棧相關輸出日誌。

    TerraformLogs

    array<object>

    Terraform 輸出日誌。僅 Terraform 類型資源棧返回該參數。 當 LogOption 未指定，或者 LogOption 取值為 Stack 或 All 時返回該參數。

    說明

    運行中的資源棧不返回該參數。該參數表示資源棧最近一次操作（建立、繼續建立、更新、刪除）的日誌。

    object

    test

    Command

    string

    執行的 Terraform 命令名稱。取值：

    • apply

    • plan

    • destroy

    • version

    關於命令含義的更多資訊，請參見 Command 。

    apply
    Stream

    string

    輸出資料流。取值：

    • stdout：標準輸出。

    • stderr：標準錯誤。

    stdout
    Content

    string

    當前命令在當前輸出資料流中輸出的內容。

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

    array<object>

    資源輸出日誌。當 LogOption 取值為 Resource 或 All 時返回該參數。

    說明

    僅部分資源類型的資源會返回資源日誌，例如：ALIYUN::ROS::ResourceCleaner。

    array<object>

    test

    ResourceName

    string

    模板中定義的資源名稱。

    MyResourceCleaner
    Logs

    array<object>

    資源關聯的所有日誌。

    object

    test

    Keys

    array

    資源關聯的某條日誌的關鍵字列表。

    string

    關鍵字。

    ResourceDetails
    Content

    string

    資源關聯的某條日誌的內容。

    []
    TemplateId

    string

    模板 ID。僅在資源棧當前所使用的模板來自於使用者自訂模板或共用模板時返回該參數。

    如果是共用模板，返回結果與模板的 TemplateARN 相同。

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

    string

    模板版本。僅在資源棧當前所使用的模板來自於使用者自訂模板或共用模板時返回該參數。

    如果為共用模板，僅當共用時參數 VersionOption 為 AllVersions 時，返回該參數。

    取值範圍：v1～v100。

    v1
    TemplateScratchId

    string

    資源情境 ID。僅在資源棧當前所使用的模板來自於資源情境時返回該參數。

    ts-7f7a704cf71c49a6****
    TemplateURL

    string

    包含模板主體的檔案的位置。僅在資源棧當前所使用的模板來自於 URL 時返回該參數，包括 Web 服務器（HTTP 或 HTTPS）或阿里雲 OSS 儲存空間等。

    oss://ros/template/demo
    Interface

    string

    介面描述資訊。

    {}
    ServiceManaged

    boolean

    是否為託管資源棧。取值：

    • true：是託管資源棧。

    • false：不是託管資源棧。

    false
    ServiceName

    string

    託管資源棧所屬的服務名稱。

    ACVS
    OperationInfo

    object

    資源棧操作發生錯誤時的補充資訊。

    說明

    該返回屬性僅在特定情況下返回，且至少返回一個子屬性。例如：調用其他雲端服務 API 報錯。

    Code

    string

    錯誤碼。

    DependencyViolation
    Message

    string

    錯誤內容。

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

    string

    調用其他雲端服務 API 的請求 ID。

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

    string

    調用其他雲端服務 API 的名稱。

    DeleteSecurityGroup
    ResourceType

    string

    發生操作錯誤的資源類型。

    ALIYUN::ECS::SecurityGroup
    LogicalResourceId

    string

    發生操作錯誤的資源邏輯 ID。

    EcsSecurityGroup
    OrderIds

    array

    訂單 ID 列表，當建立資源棧時設定了手動支付訂用帳戶訂單時才會返回。

    string

    訂單 ID 資訊。

    2161413696****
    CheckedStackResourceCount

    integer

    已執行偏差檢查的資源數。

    說明

    僅在資源棧上次偏差檢測成功時返回。

    1
    NotCheckedStackResourceCount

    integer

    沒有執行過偏差檢查的資源數。

    說明

    僅在資源棧上次偏差檢測成功時返回。

    1
    RollbackFailedRootReason

    string

    當資源棧狀態為復原失敗時，該欄位展示導致復原的前一階段執行失敗的原因。

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

    樣本

    正常返回樣本

    JSON格式

    {
  "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"
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。