全部產品
Search

搜尋本產品

    Resource Orchestration Service：ListStacks - 查詢資源棧列表

    文件中心

    Resource Orchestration Service：ListStacks - 查詢資源棧列表

    更新時間：Dec 15, 2025

    查詢資源棧列表。

    介面說明

    使用說明

    本文將提供一個樣本，為您查詢杭州地區的資源棧列表。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    ros:ListStacks

    get

    *Stack

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    PageSize

    integer

    否

    分頁查詢時設定的每頁行數。

    最大值：50。

    預設值：10。

    10
    ParentStackId

    string

    否

    父資源棧 ID。

    4a6c9851-3b0f-4f5f-b4ca-a14bf691****
    RegionId

    string

    是

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

    cn-hangzhou
    PageNumber

    integer

    否

    資源棧列表的頁碼。

    起始值：1。

    預設值：1。

    1
    ShowNestedStack

    boolean

    否

    是否列出嵌套資源棧。取值：

    • true

    • false（預設值）

    說明

    如果指定了 ParentStackId，則該值為 true。

    true
    StackId

    string

    否

    資源棧 ID。如果不需要資源棧詳細資料，可以指定此參數，代替 GetStack 介面。

    4a6c9851-3b0f-4f5f-b4ca-a14bf691****
    Status

    array

    否

    資源棧狀態。

    CREATE_COMPLETE

    string

    否

    資源棧狀態，取值：

    • CREATE_IN_PROGRESS：資源棧建立中。

    • CREATE_FAILED：資源棧建立失敗。

    • CREATE_COMPLETE：資源棧建立成功。

    • UPDATE_IN_PROGRESS：資源棧更新中。

    • UPDATE_FAILED：資源棧更新失敗。

    • UPDATE_COMPLETE：資源棧更新成功。

    • DELETE_IN_PROGRESS：資源棧刪除中。

    • DELETE_FAILED：資源棧刪除失敗。

    • 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
    StackName

    array

    否

    資源棧名稱。

    MyStack

    string

    否

    資源棧名稱。
    長度不超過 255 個字元，必須以數字或英文字母開頭，可包含數字、英文字母、短劃線（-）和底線（_）。支援使用星號（*）進行模糊搜尋。

    N 的取值範圍：1~5。

    MyStack
    Tag

    array<object>

    否

    資源棧的標籤。

    object

    否

    Key

    string

    否

    資源棧的標籤鍵。
    N 的取值範圍：1~20。

    usage
    Value

    string

    否

    資源棧的標籤值。
    N 的取值範圍：1~20。

    test
    ResourceGroupId

    string

    否

    資源群組 ID。
    關於資源群組的更多資訊，請參見什麼是資源群組。

    rg-acfmxazb4ph6aiy****
    StackIds

    array

    否

    資源棧 ID 列表。

    string

    否

    資源棧 ID。 您可以指定多個資源棧 ID，同時查詢多個資源棧的詳細資料。 N 的取值範圍：1~10。

    4a6c9851-3b0f-4f5f-b4ca-a14bf691****
    StartTime

    string

    否

    按建立時間查詢，建立時間區間的起始點。按照ISO 8601標準表示，並需要使用 UTC +0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。

    2023-04-01T15:10:00Z
    EndTime

    string

    否

    按建立時間查詢，建立時間區間的終止點。按照ISO 8601標準表示，並需要使用 UTC +0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。

    2023-04-01T15:16:00Z

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

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    TotalCount

    integer

    資源棧總個數。

    2
    PageSize

    integer

    分頁查詢時設定的每頁行數。

    最大值：50。

    預設值：10。

    10
    RequestId

    string

    請求 ID。

    FBAC80B4-9C27-529D-BC9C-4155FA5CD7A7
    PageNumber

    integer

    資源棧列表的頁碼。

    1
    Stacks

    array<object>

    資源棧列表。

    array<object>

    Status

    string

    資源棧狀態。

    CREATE_COMPLETE
    UpdateTime

    string

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

    2022-03-10T07:44:36
    DriftDetectionTime

    string

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

    2022-03-10T06:46:36
    StatusReason

    string

    資源棧狀態原因。

    Stack CREATE completed successfully
    CreateTime

    string

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

    2022-03-10T06:44:36
    DisableRollback

    boolean

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

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

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

    false
    Tags

    array<object>

    資源棧的標籤。

    object

    Key

    string

    資源棧的標籤鍵。

    acs:rm:rgId
    Value

    string

    資源棧的標籤值。

    rg-aek2frunvw7****
    StackName

    string

    資源棧名稱。

    MyStack
    TimeoutInMinutes

    integer

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

    60
    RegionId

    string

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

    cn-hangzhou
    ParentStackId

    string

    父資源棧 ID。

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

    string

    資源棧 ID。

    67805444-a605-45ee-a57f-83908ff6****
    StackDriftStatus

    string

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

    • DRIFTED：資源棧處於檢測狀態。

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

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

    IN_SYNC
    StackType

    string

    資源棧類型，取值：

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

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

    ROS
    ResourceGroupId

    string

    資源群組 ID。

    rg-aek2frunvw7****
    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
    DeletionProtection

    string

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

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

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

    說明

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

    枚舉值：

    • Enabled :

      Enabled

    • Disabled :

      Disabled

    Disabled

    樣本

    正常返回樣本

    JSON格式

    {
  "TotalCount": 2,
  "PageSize": 10,
  "RequestId": "FBAC80B4-9C27-529D-BC9C-4155FA5CD7A7",
  "PageNumber": 1,
  "Stacks": [
    {
      "Status": "CREATE_COMPLETE",
      "UpdateTime": "2022-03-10T07:44:36",
      "DriftDetectionTime": "2022-03-10T06:46:36",
      "StatusReason": "Stack CREATE completed successfully",
      "CreateTime": "2022-03-10T06:44:36",
      "DisableRollback": false,
      "Tags": [
        {
          "Key": "acs:rm:rgId",
          "Value": "rg-aek2frunvw7****"
        }
      ],
      "StackName": "MyStack",
      "TimeoutInMinutes": 60,
      "RegionId": "cn-hangzhou",
      "ParentStackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
      "StackId": "67805444-a605-45ee-a57f-83908ff6****",
      "StackDriftStatus": "IN_SYNC",
      "StackType": "ROS",
      "ResourceGroupId": "rg-aek2frunvw7****",
      "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"
      },
      "DeletionProtection": "Disabled"
    }
  ]
}

    錯誤碼

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

    變更歷史

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