Queries a list of stacks.
Operation description
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ros:ListStacks | LIST |
|
| none |
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:
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_COMPLETE | |
StackName | array | No | The names of the stacks. | |
string | No | The name of stack N. Valid values of N: 1 to 5. | MyStack | |
Tag | object [] | No | The tags of the stack. | |
Key | string | No | The key of tag N. | usage |
Value | string | No | The value of tag N. | test |
ResourceGroupId | string | No | The ID of the resource group. | 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
Examples
Sample success responses
JSON
format
{
"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 | see changesets | ||||||
| ||||||||
2023-04-13 | The request parameters of the API has changed | see changesets | ||||||
| ||||||||
2022-02-22 | The response structure of the API has changed | see changesets | ||||||
|