ListStacks - Resource Orchestration Service - Alibaba Cloud Documentation Center

Queries a list of stacks.

Operation description

This topic provides an example on how to query a list of stacks. In this example, the stacks that are deployed in the China (Hangzhou) region are queried.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
PageSize	long	No	The number of entries per page. Maximum value: 50. Default value: 10.	10
ParentStackId	string	No	The ID of the parent stack.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
RegionId	string	Yes	The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
PageNumber	long	No	The page number. Pages start from page 1. Default value: 1.	1
ShowNestedStack	boolean	No	Specifies whether to return nested stacks. Valid values: true false (default) Note If you specify ParentStackId, you must set ShowNestedStack to true.	true
StackId	string	No	The stack ID. You can specify this parameter to query only the stack ID. If you want to query the detailed information about the stack, call the GetStack operation.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
Status	array	No	The status of the stack.
	string	No	The state of the stack. Valid values: CREATE_IN_PROGRESS: The stack is being created. CREATE_FAILED: The stack fails to be created. CREATE_COMPLETE: The stack is created. UPDATE_IN_PROGRESS: The stack is being updated. UPDATE_FAILED: The stack fails to be updated. UPDATE_COMPLETE: The stack is updated. DELETE_IN_PROGRESS: The stack is being deleted. DELETE_FAILED: The stack fails to be deleted. CREATE_ROLLBACK_IN_PROGRESS: The resources are being rolled back after the stack fails to be created. CREATE_ROLLBACK_FAILED: The resources fail to be rolled back after the stack fails to be created. CREATE_ROLLBACK_COMPLETE: The resources are rolled back after the stack fails to be created. ROLLBACK_IN_PROGRESS: The resources of the stack are being rolled back. ROLLBACK_FAILED: The resources of the stack fail to be rolled back. ROLLBACK_COMPLETE: The resources of the stack are rolled back. CHECK_IN_PROGRESS: The stack is being validated. CHECK_FAILED: The stack fails to be validated. CHECK_COMPLETE: The stack is validated. REVIEW_IN_PROGRESS: The stack is being reviewed. IMPORT_CREATE_IN_PROGRESS: The stack is being created by using imported resources. IMPORT_CREATE_FAILED: The stack fails to be created by using imported resources. IMPORT_CREATE_COMPLETE: The stack is created by using imported resources. IMPORT_CREATE_ROLLBACK_IN_PROGRESS: The resources are being rolled back after the stack fails to be created by using imported resources. IMPORT_CREATE_ROLLBACK_FAILED: The resources fail to be rolled back after the stack fails to be created by using imported resources. IMPORT_CREATE_ROLLBACK_COMPLETE: The resources are rolled back after the stack fails to be created by using imported resources. IMPORT_UPDATE_IN_PROGRESS: The stack is being updated by using imported resources. IMPORT_UPDATE_FAILED: The stack fails to be updated by using imported resources. IMPORT_UPDATE_COMPLETE: The stack is updated by using imported resources. IMPORT_UPDATE_ROLLBACK_IN_PROGRESS: The resources are being rolled back after the stack fails to be updated by using imported resources. IMPORT_UPDATE_ROLLBACK_FAILED: The resources fail to be rolled back after the stack fails to be updated by using imported resources. IMPORT_UPDATE_ROLLBACK_COMPLETE: The resources are rolled back after the stack fails to be updated by using imported resources.	CREATE_COMPLETE
StackName	array	No	The names of the stacks.
	string	No	The name of stack N. The name can be up to 255 characters in length, and can contain digits, letters, hyphens (-), and underscores (_). It must start with a digit or letter. You can use the wildcard character (*) for fuzzy search. Valid values of N: 1 to 5.	MyStack
Tag	array<object>	No	The tags of the stack.
	object	No
Key	string	No	The key of tag N. Valid values of N: 1 to 20.	usage
Value	string	No	The value of tag N. Valid values of N: 1 to 20.	test
ResourceGroupId	string	No	The ID of the resource group. For more information about resource groups, see the "Resource Group" section of the What is Resource Management? topic.	rg-acfmxazb4ph6aiy****
StackIds	array	No	The IDs of the stacks.
	string	No	The ID of stack N. You can specify one or more IDs to query one or more stacks at the same time. Valid values of N: 1 to 10.	4a6c9851-3b0f-4f5f-b4ca-a14bf691****
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-04-01T15:10:00Z
EndTime	string	No	The end of the time range during which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-04-01T15:16:00Z

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The total number of stacks.	2
PageSize	integer	The number of entries per page. Maximum value: 50. Default value: 10.	10
RequestId	string	The request ID.	FBAC80B4-9C27-529D-BC9C-4155FA5CD7A7
PageNumber	integer	The page number.	1
Stacks	array<object>	Details of the stacks.
	object
Status	string	The state of the stack.	CREATE_COMPLETE
UpdateTime	string	The time when the stack was updated. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.	2022-03-10T07:44:36
DriftDetectionTime	string	The time when the most recent successful drift detection was performed on the stack.	2022-03-10T06:46:36
StatusReason	string	The reason why the stack is in its current state.	Stack CREATE completed successfully
CreateTime	string	The time when the stack was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.	2022-03-10T06:44:36
DisableRollback	boolean	Indicates whether rollback is disabled when the stack fails to be created. Valid values: true false (default)	false
Tags	array<object>	The tags of the stack.
	object
Key	string	The tag key of the stack.	acs:rm:rgId
Value	string	The tag value of the stack.	rg-aek2frunvw7****
StackName	string	The stack name.	MyStack
TimeoutInMinutes	integer	The timeout period for creating the stack. Unit: minutes.	60
RegionId	string	The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ParentStackId	string	The ID of the parent stack.	4a6c9851-3b0f-4f5f-b4ca-a14bf692****
StackId	string	The stack ID.	67805444-a605-45ee-a57f-83908ff6****
StackDriftStatus	string	The state of the stack on which the most recent successful drift detection was performed. Valid values: DRIFTED: The stack has drifted. NOT_CHECKED: No successful drift detection is performed on the stack. IN_SYNC: The stack is being synchronized.	IN_SYNC
StackType	string	The stack type. Valid values: ROS: ROS stack. The stack is created by using a ROS template. Terraform: Terraform stack. The stack is created by using a Terraform template.	ROS
ResourceGroupId	string	The ID of the resource group.	rg-aek2frunvw7****
ServiceManaged	boolean	Indicates whether the stack is a managed stack. Valid values: true false	false
ServiceName	string	The name of the service to which the managed stack belongs.	ACVS
OperationInfo	object	The supplementary information that is returned if an error occurs on a stack operation. Note This parameter is returned only under specific conditions, and is returned together with at least one sub-parameter. For example, an error occurred when an API operation of another Alibaba Cloud service was called.
Code	string	The error code.	DependencyViolation
Message	string	The error message.	There is still instance(s) in the specified security group.
RequestId	string	The ID of the request that is initiated to call the API operation of another Alibaba Cloud service.	071D6166-3F6B-5C7B-A1F0-0113FBB643A8
Action	string	The name of the API operation that belongs to another Alibaba Cloud service.	DeleteSecurityGroup
ResourceType	string	The type of the resource on which the operation error occurred.	ALIYUN::ECS::SecurityGroup
LogicalResourceId	string	The logical ID of the resource on which the operation error occurred.	EcsSecurityGroup
DeletionProtection	string	Indicates whether deletion protection is enabled for the stack. Valid values: Enabled: Deletion protection is enabled for the stack. Disabled: Deletion protection is disabled for the stack. In this case, you can delete the stack by using the console or calling the DeleteStack operation. Note Deletion protection of a nested stack is the same as that of its root stack.	Disabled

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-08-11	The response structure of the API has changed	View Change Details
2023-04-13	The request parameters of the API has changed	View Change Details
2022-02-22	The response structure of the API has changed	View Change Details