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

使用说明

本文将提供一个示例,为您查询杭州地域的资源栈列表。

调试

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

请求参数

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

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

PageSize Long 10

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

最大值:50。

默认值:10。

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

父资源栈ID。

RegionId String cn-hangzhou

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

PageNumber Long 1

资源栈列表的页码。

起始值:1。

默认值:1。

ShowNestedStack Boolean true

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

  • true
  • false(默认值)
    说明 如果指定了ParentStackId,则该值为true。
StackId String 4a6c9851-3b0f-4f5f-b4ca-a14bf691****

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

ResourceGroupId String rg-acfmxazb4ph6aiy****

资源组ID。

关于资源组的更多信息,请参见什么是资源组

Status.N String CREATE_COMPLETE

资源栈状态,取值:

  • 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:通过资源导入更新资源栈回滚成功。
StackName.N String MyStack

资源栈名称。

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

N的取值范围:1~5。

Tag.N.Key String usage

资源栈的标签键。

N的取值范围:1~20。

Tag.N.Value String test

资源栈的标签值。

N的取值范围:1~20。

StackIds.N String 4a6c9851-3b0f-4f5f-b4ca-a14bf691****

资源栈ID。

您可以指定多个资源栈ID,同时查询多个资源栈的详细信息。

N的取值范围:1~10。

关于公共请求参数的详情,请参见公共参数

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

资源栈总个数。

PageSize Integer 10

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

最大值:50。

默认值:10。

RequestId String B288A0BE-D927-4888-B0F7-B35EF84B6E6F

请求ID。

PageNumber Integer 1

资源栈列表的页码。

Stacks Array of Stack

资源栈列表。

Status String CREATE_COMPLETE

资源栈状态。

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

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

DriftDetectionTime String 2020-02-27T07:47:47

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

StatusReason String Stack successfully created

资源栈状态原因。

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

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

DisableRollback Boolean false

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

  • true:禁用回滚,即当创建资源栈失败时不进行回滚。
  • false(默认值):不禁用回滚,即当创建资源栈失败时进行回滚。
Tags Array of Tag

资源栈的标签。

Key String usage

资源栈的标签键。

Value String test

资源栈的标签值。

StackName String MyStack

资源栈名称。

TimeoutInMinutes Integer 10

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

RegionId String cn-hangzhou

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

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

父资源栈ID。

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

资源栈ID。

StackDriftStatus String IN_SYNC

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

  • DRIFTED:资源栈处于检测状态。
  • NOT_CHECKED:资源栈未进行过成功的偏差检测。
  • IN_SYNC:资源栈处于同步状态。
StackType String ROS

资源栈类型,取值:

  • ROS:使用ROS模板的资源栈。
  • Terraform:使用Terraform模板的资源栈。
ResourceGroupId String rg-acfmxazb4ph6aiy****

资源组ID。

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Stacks" : [ {
    "StackId" : "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
    "ParentStackId" : "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
    "StackName" : "MyStack",
    "RegionId" : "cn-hangzhou",
    "ResourceGroupId" : "rg-acfmxazb4ph6aiy****",
    "DisableRollback" : false,
    "CreateTime" : "2019-08-01T04:07:39",
    "Status" : "CREATE_COMPLETE",
    "StatusReason" : "Stack successfully created",
    "Tags" : [ {
      "Value" : "test",
      "Key" : "usage"
    } ],
    "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"
}

错误码

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