调用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 |
是否列出嵌套资源栈。取值:
|
StackId | String | 否 | 4a6c9851-3b0f-4f5f-b4ca-a14bf691**** |
资源栈ID。如果不需要资源栈详细信息,可以指定此参数,代替GetStack接口。 |
ResourceGroupId | String | 否 | rg-acfmxazb4ph6aiy**** |
资源组ID。 关于资源组的更多信息,请参见什么是资源组。 |
Status.N | String | 否 | CREATE_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 | 2 |
资源栈总个数。 |
PageSize | Integer | 10 |
分页查询时设置的每页行数。 最大值:50。 默认值:10。 |
RequestId | String | FBAC80B4-9C27-529D-BC9C-4155FA5CD7A7 |
请求ID。 |
PageNumber | Integer | 1 |
资源栈列表的页码。 |
Stacks | Array of Stack |
资源栈列表。 |
|
Status | String | CREATE_COMPLETE |
资源栈状态。 |
UpdateTime | String | 2022-03-10T07:44:36 |
资源栈更新时间。按照ISO8601标准表示,需使用UTC时间,格式:YYYY-MM-DDThh:mm:ss。 |
DriftDetectionTime | String | 2022-03-10T06:46:36 |
资源栈最近一次成功的偏差检测的时间。 |
StatusReason | String | Stack CREATE completed successfully |
资源栈状态原因。 |
CreateTime | String | 2022-03-10T06:44:36 |
创建时间。按照ISO8601标准表示,需使用UTC时间,格式:YYYY-MM-DDThh:mm:ss。 |
DisableRollback | Boolean | false |
当创建资源栈失败时,是否禁用回滚策略。取值:
|
Tags | Array of Tag |
资源栈的标签。 |
|
Key | String | acs:rm:rgId |
资源栈的标签键。 |
Value | String | rg-aek2frunvw7**** |
资源栈的标签值。 |
StackName | String | MyStack |
资源栈名称。 |
TimeoutInMinutes | Integer | 60 |
创建资源栈的超时时间。单位:分钟。 |
RegionId | String | cn-hangzhou |
资源栈所属的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
ParentStackId | String | 4a6c9851-3b0f-4f5f-b4ca-a14bf692**** |
父资源栈ID。 |
StackId | String | 67805444-a605-45ee-a57f-83908ff6**** |
资源栈ID。 |
StackDriftStatus | String | IN_SYNC |
资源栈最近一次成功的偏差检测中的资源栈状态,取值:
|
StackType | String | ROS |
资源栈类型,取值:
|
ResourceGroupId | String | rg-aek2frunvw7**** |
资源组ID。 |
ServiceManaged | Boolean | false |
是否为托管资源栈。取值:
|
ServiceName | String | ACVS |
托管资源栈所属的服务名称。 |
示例
请求示例
http(s)://ros.aliyuncs.com/?Action=ListStacks
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListStacksResponse>
<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<RequestId>FBAC80B4-9C27-529D-BC9C-4155FA5CD7A7</RequestId>
<PageNumber>1</PageNumber>
<Stacks>
<Status>CREATE_COMPLETE</Status>
<StackType>ROS</StackType>
<ResourceGroupId>rg-aek2frunvw7****</ResourceGroupId>
<ServiceManaged>false</ServiceManaged>
<StatusReason>Stack CREATE completed successfully</StatusReason>
<CreateTime>2022-03-10T06:44:36</CreateTime>
<RegionId>cn-hangzhou</RegionId>
<DisableRollback>false</DisableRollback>
<StackName>MyStack</StackName>
<Tags>
<Value>rg-aek2frunvw7****</Value>
<Key>acs:rm:rgId</Key>
</Tags>
<TimeoutInMinutes>60</TimeoutInMinutes>
<StackId>67805444-a605-45ee-a57f-83908ff6****</StackId>
</Stacks>
<Stacks>
<Status>CREATE_COMPLETE</Status>
<StackType>ROS</StackType>
<ResourceGroupId>rg-acfmzawhxxc****</ResourceGroupId>
<ServiceManaged>false</ServiceManaged>
<StatusReason>Stack CREATE completed successfully</StatusReason>
<CreateTime>2020-10-22T05:53:32</CreateTime>
<RegionId>cn-hangzhou</RegionId>
<DisableRollback>false</DisableRollback>
<StackName>MyStack2</StackName>
<TimeoutInMinutes>60</TimeoutInMinutes>
<StackId>1ae37e7b-cdf0-4709-b53d-292260a0****</StackId>
</Stacks>
</ListStacksResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 2,
"PageSize" : 10,
"RequestId" : "FBAC80B4-9C27-529D-BC9C-4155FA5CD7A7",
"PageNumber" : 1,
"Stacks" : [ {
"Status" : "CREATE_COMPLETE",
"StackType" : "ROS",
"ResourceGroupId" : "rg-aek2frunvw7****",
"ServiceManaged" : false,
"StatusReason" : "Stack CREATE completed successfully",
"CreateTime" : "2022-03-10T06:44:36",
"RegionId" : "cn-hangzhou",
"DisableRollback" : false,
"StackName" : "MyStack",
"Tags" : [ {
"Value" : "rg-aek2frunvw7****",
"Key" : "acs:rm:rgId"
} ],
"TimeoutInMinutes" : 60,
"StackId" : "67805444-a605-45ee-a57f-83908ff6****"
}, {
"Status" : "CREATE_COMPLETE",
"StackType" : "ROS",
"ResourceGroupId" : "rg-acfmzawhxxc****",
"ServiceManaged" : false,
"StatusReason" : "Stack CREATE completed successfully",
"CreateTime" : "2020-10-22T05:53:32",
"RegionId" : "cn-hangzhou",
"DisableRollback" : false,
"StackName" : "MyStack2",
"Tags" : [ ],
"TimeoutInMinutes" : 60,
"StackId" : "1ae37e7b-cdf0-4709-b53d-292260a0****"
} ]
}
错误码
访问错误中心查看更多错误码。