调用ListStacks接口查询资源栈列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListStacks

要执行的操作,取值:ListStacks。

RegionId String cn-hangzhou

资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

Status.N RepeatList CREATE_COMPLETE

资源栈状态,取值:

  • 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

N的取值范围为:1~5。

PageSize Long 10

分页查询时设置的每页行数。

最大值:50。

默认值:10。

ParentStackId String 4a6c9851-3b0f-4f5f-b4ca-a14bf691****

父资源栈ID。

StackName.N RepeatList MyStack

资源栈名称。

长度不超过255个字符,必须以数字或英文字母开头,可包含数字、英文字母、短划线(-)和下划线(_)。支持使用星号(*)进行模糊搜索。

N的取值范围为:1~5。

PageNumber Long 1

资源栈列表的页码。

起始值:1。

默认值:1。

ShowNestedStack Boolean true

是否列出嵌套资源栈。取值:

  • true
  • false(默认值)
    说明 如果指定了ParentStackId,则该值为true。
Tag.N.Key String usage

实例的标签键。

N的取值范围为:1~20。

Tag.N.Value String test

实例的标签值。

N的取值范围为:1~20。

StackId String 4a6c9851-3b0f-4f5f-b4ca-a14bf691****

资源栈ID。如果不需要资源栈详细信息,可以指定此参数,代替GetStack接口。

返回数据

名称 类型 示例值 描述
Stacks Array of Stack

资源栈列表。

CreateTime String 2019-08-01T04:07:39

创建时间。按照ISO8601标准表示,需使用UTC时间,格式:YYYY-MM-DDThh:mm:ss。

DisableRollback Boolean false

当创建资源栈失败时,是否禁用回滚策略。取值:

  • true:禁用回滚,即当创建资源栈失败时不进行回滚。
  • false(默认值):不禁用回滚,即当创建资源栈失败时进行回滚。
DriftDetectionTime String 2020-02-27T07:47:47

资源栈最近一次成功的偏差检测的时间。

ParentStackId String 4a6c9851-3b0f-4f5f-b4ca-a14bf692****

父资源栈ID。

RegionId String cn-hangzhou

资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

StackDriftStatus String IN_SYNC

资源栈最近一次成功的偏差检测中的资源栈状态,取值:

  • DRIFTED:资源栈处于检测状态。
  • NOT_CHECKED:资源栈未进行过成功的偏差检测。
  • IN_SYNC:资源栈处于同步状态。
StackId String 4a6c9851-3b0f-4f5f-b4ca-a14bf691****

资源栈ID。

StackName String MyStack

资源栈名称。

StackType String ROS

资源栈类型,取值:

  • ROS:使用ROS模板的资源栈。
  • Terraform:使用Terraform模板的资源栈。
Status String CREATE_COMPLETE

资源栈状态,取值:

  • 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
StatusReason String Stack successfully created

资源栈状态原因。

TimeoutInMinutes Integer 10

创建资源栈的超时时间。单位:分钟。

UpdateTime String 2019-08-01T04:07:39

资源栈更新时间。按照ISO8601标准表示,需使用UTC时间,格式:YYYY-MM-DDThh:mm:ss。

PageSize Integer 10

分页查询时设置的每页行数。

最大值:50。

默认值:10。

PageNumber Integer 1

资源栈列表的页码。

TotalCount Integer 1

资源栈总个数。

RequestId String B288A0BE-D927-4888-B0F7-B35EF84B6E6F

请求ID。

示例

请求示例

http(s)://ros.aliyuncs.com/?Action=ListStacks
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式

<ListStacksResponse>
    <Stacks>
        <Stack>
            <StackId>4a6c9851-3b0f-4f5f-b4ca-a14bf691****</StackId>
            <ParentStackId>4a6c9851-3b0f-4f5f-b4ca-a14bf692****</ParentStackId>
            <StackName>StackName</StackName>
            <RegionId>cn-hangzhou</RegionId>
            <DisableRollback>false</DisableRollback>
            <CreateTime>2019-08-01T04:07:39</CreationTime>
            <Status>CREATE_COMPLETE</Status>
            <StatusReason>Stack successfully created</StatusReason>
            <TimeoutInMinutes>10</TimeoutInMinutes>
            <UpdatedTime>2019-08-01T04:07:39</UpdatedTime>
            <DriftDetectionTime>2020-02-27T07:47:47</DriftDetectionTime>
            <StackDriftStatus>IN_SYNC</StackDriftStatus>
            <StackType>ROS</StackType>
        </Stack>
    </Stacks>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>1</TotalCount>
    <RequestId>B288A0BE-D927-4888-B0F7-B35EF84B6E6F</RequestId>    
</ListStacksResponse>

JSON 格式

{
    "Stacks": [
        {
            "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
            "ParentStackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
            "StackName": "MyStack",
            "RegionId": "cn-hangzhou",
            "DisableRollback": false,
            "CreateTime": "2019-08-01T04:07:39",
            "Status": "CREATE_COMPLETE",
            "StatusReason": "Stack successfully created",
            "TimeoutInMinutes": 10,
            "UpdatedTime": "2019-08-01T04:07:39",
            "DriftDetectionTime": "2020-02-27T07:47:47",
		    "StackDriftStatus": "IN_SYNC",
            "StackType": "ROS"
        }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F"    
}

错误码

访问错误中心查看更多错误码。