ListStacks - 查询资源栈列表 - 资源编排

查询资源栈列表。

接口说明

使用说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ros:ListStacks	get	Stack acs:ros:{#regionId}:{#accountId}:stack/*	无	无

请求参数

名称	类型	必填	描述	示例值
PageSize	long	否	分页查询时设置的每页行数。最大值：50。默认值：10。	10
ParentStackId	string	否	父资源栈 ID。	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
RegionId	string	是	资源栈所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。	cn-hangzhou
PageNumber	long	否	资源栈列表的页码。起始值：1。默认值：1。	1
ShowNestedStack	boolean	否	是否列出嵌套资源栈。取值： true false（默认值）说明如果指定了 ParentStackId，则该值为 true。	true
StackId	string	否	资源栈 ID。如果不需要资源栈详细信息，可以指定此参数，代替 GetStack 接口。	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
Status	array	否	资源栈状态。
	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	否	资源栈名称。
	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>	资源栈列表。
	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 接口释放资源栈。说明嵌套资源栈的删除保护机制与根资源栈一致。	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"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-08-11	OpenAPI 返回结构发生变更	查看变更详情
2023-04-13	OpenAPI 入参发生变更	查看变更详情
2022-02-22	OpenAPI 返回结构发生变更	查看变更详情