ListStacks

Description

call the ListStacks interface to query the resource stack list.

Request Method

POST

Request Path

/apsara/route/ROS/ListStacks

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
Tag.N.Key	BODY	string	No	usage	tag key of the resource stack. The value range of N is: 1~20.
PageSize	BODY	long	No	10	the number of rows per page set during paging query. Maximum value: 50. default value: 10.
ShowNestedStack	BODY	boolean	No	true	whether to list nested resource stacks. Value: true false (default) description if ParentStackId is specified, the value is true.
Status.N	BODY	repeatlist	No	CREATE_COMPLETE	resource stack status, value: CREATE_IN_PROGRESS CREATE_FAILED CREATE_COMPLETE UPDATE_IN_PROGRESS UPDATE_FAILED UPDATE_COMPLETE DELETE_IN_PROGRESS DELETE_FAILED DELETE_COMPLETE 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 The value range of N is: 1~5.
ParentStackId	BODY	string	No	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	parent stack ID.
version	BODY	string	No	2016-01-01	version of api
PageNumber	BODY	long	No	1	page number of the resource stack list. starting value: 1. default value: 1.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
Tag.N.Value	BODY	string	No	test	the label value of the resource stack. The value range of N is: 1~20.
RegionId	BODY	string	Yes	cn-hangzhou	the region ID to which the resource stack belongs.
StackName.N	BODY	repeatlist	No	MyStack	resource stack name. must be no more than 255 characters in length and must start with a number or an English letter, which can contain numbers, English letters, dashes (-), and underscores (_). Fuzzy search using asterisks (*) is supported. The value range of N is: 1~5.
StackId	BODY	string	No	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	resource stack ID. If you do not need stack details, you can specify this parameter instead of GetStack the interface.

Return data

Name	Type	Sample value	Description
Status	string	CREATE_COMPLETE	resource stack status, value: CREATE_IN_PROGRESS CREATE_FAILED CREATE_COMPLETE UPDATE_IN_PROGRESS UPDATE_FAILED UPDATE_COMPLETE DELETE_IN_PROGRESS DELETE_FAILED DELETE_COMPLETE 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
PageSize	integer	10	the number of rows per page set during paging query. Maximum value: 50. default value: 10.
RequestId	string	B288A0BE-D927-4888-B0F7-B35EF84B6E6F	request ID.
ParentStackId	string	4a6c9851-3b0f-4f5f-b4ca-a14bf692****	parent stack ID.
StatusReason	string	Stack successfully created	resource stack status reason.
CreateTime	string	2019-08-01T04:07:39	creation time. According to the ISO8601 standard, UTC time is required, format: YYYY-MM-DDThh:mm:ss.
StackType	string	ROS	resource stack type. The value is ROS, which indicates the resource stack that uses the ROS template.
TotalCount	integer	1	total number of resource stacks.
PageNumber	integer	1	page number of the resource stack list.
UpdateTime	string	2019-08-01T04:07:39	resource stack update time. According to the ISO8601 standard, UTC time is required, format: YYYY-MM-DDThh:mm:ss.
Stacks	array of stack	No sample value for this parameter.	resource stack list.
DriftDetectionTime	string	2020-02-27T07:47:47	the time of the last successful deviation detection of the resource stack.
RegionId	string	cn-hangzhou	the region ID to which the resource stack belongs.
StackDriftStatus	string	IN_SYNC	resource stack status in the latest successful deviation detection of the resource stack, value: DRIFTED: the resource stack is in the detection state. NOT_CHECKED: no successful deviation detection has been performed on the resource stack. IN_SYNC: the resource stack is synchronized.
DisableRollback	boolean	false	whether to disable the rollback policy when the resource stack creation fails. Value: true: disable rollback, that is, no rollback is performed when the resource stack creation fails. false (default): rollback is not disabled, that is, rollback is performed when the resource stack creation fails.
StackName	string	MyStack	resource stack name.
StackId	string	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	resource stack ID.
TimeoutInMinutes	integer	10	timeout for creating the resource stack. Unit: Minutes.

Example

Successful Response example

{
 "Status":"CREATE_COMPLETE",
 "PageSize":"10",
 "RequestId":"B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
 "ParentStackId":"4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
 "StatusReason":"Stack successfully created",
 "CreateTime":"2019-08-01T04:07:39",
 "StackType":"ROS",
 "TotalCount":"1",
 "PageNumber":"1",
 "UpdateTime":"2019-08-01T04:07:39",
 "Stacks":"",
 "DriftDetectionTime":"2020-02-27T07:47:47",
 "RegionId":"cn-hangzhou",
 "StackDriftStatus":"IN_SYNC",
 "DisableRollback":"false",
 "StackName":"MyStack",
 "StackId":"4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
 "TimeoutInMinutes":"10"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}