查询资源栈列表。

调试

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

请求参数

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

系统规定参数。取值:ListStacks。

RegionId String cn-hangzhou

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

StackName.N RepeatList MyStack

资源栈名称,必须唯一。资源栈名称可以包含数字、字母(大小写敏感)、连字符、下划线。必须以数字或字母开头,且长度不超过255个字符。

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
  • ROLLBACK_IN_PROGRESS
  • ROLLBACK_FAILED
  • ROLLBACK_COMPLETE
  • CHECK_IN_PROGRESS
  • CHECK_FAILED
  • CHECK_COMPLETE
  • REVIEW_IN_PROGRESS
ParentStackId String xxxx

父资源栈 ID。用于列出嵌套资源栈。

ShowNestedStack Boolean true

是否列出嵌套资源栈。仅当指定ParentStackId时生效。

PageNumber Long 1

资源栈列表的页码,起始值为 1。

默认值为 1。

PageSize Long 10

分页查询时设置的每页行数,最大值 100。

默认为 10。

返回数据

名称 类型 示例值 描述
Stacks

资源栈列表。

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

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

DisableRollback Boolean false

当创建资源栈失败时,是否禁用回滚策略,默认为false。

  • true 表示禁用回滚,即在创建资源栈失败时不会进行回滚;
  • false 表示不禁用回滚,即在创建资源栈失败时会进行回滚。
ParentStackId String xxxxxxx

父堆栈 ID。

RegionId String cn-hangzhou

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

StackId String 4a6c9851-3b0f-4f5f-b4ca-a14bf691f2ff

堆栈 ID。

StackName String MyStack

堆栈名称。

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
  • ROLLBACK_IN_PROGRESS
  • ROLLBACK_FAILED
  • ROLLBACK_COMPLETE
  • CHECK_IN_PROGRESS
  • CHECK_FAILED
  • CHECK_COMPLETE
  • REVIEW_IN_PROGRESS
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

分页查询时设置的每页行数,最大值 100。

默认为 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-a14bf691f2ff</StackId>
                  <ParentStackId>xxxx</ParentStackId>
                  <StackName>StackName</StackName>
                  <RegionId>cn-hangzhou</RegionId>
                  <DisableRollback>false</DisableRollback>
                  <CreationTime>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>
            </Stack>
      </Stacks>
      <PageNumber>1</PageNumber>
      <PageSize>10</PageSize>
      <TotalCount>1</TotalCount>
      <RequestId>B288A0BE-D927-4888-B0F7-B35EF84B6E6F</RequestId>    
</ListStacksResponse>

JSON 格式

{
	"PageNumber":1,
	"TotalCount":1,
	"PageSize":10,
	"RequestId":"B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
	"Stacks":[
		{
			"CreationTime":"2019-08-01T04:07:39",
			"StatusReason":"Stack successfully created",
			"Status":"CREATE_COMPLETE",
			"TimeoutInMinutes":10,
			"ParentStackId":"xxxxxxx",
			"StackId":"4a6c9851-3b0f-4f5f-b4ca-a14bf691f2ff",
			"RegionId":"cn-hangzhou",
			"UpdatedTime":"2019-08-01T04:07:39",
			"DisableRollback":false,
			"StackName":"MyStack"
		}
	]
}

错误码

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

访问公共错误码查看更多错误码。