GetStack - API Reference| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	GetStack	The operation that you want to perform. Set the value to GetStack.
RegionId	String	Yes	cn-hangzhou	The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.
StackId	String	Yes	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	The ID of the stack.
ClientToken	String	No	123e4567-e89b-12d3-a456-42665544****	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. It can be up to 64 characters in length, and can contain letters, digits, hyphens (-), and underscores (_). For more information, see How to ensure idempotence.

Response parameters


Parameter	Type	Example	Description
CreateTime	String	2019-08-01T04:07:39	The time when the stack was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.
Description	String	my stack description	The description of the stack.
DisableRollback	Boolean	false	Indicates whether rollback is disabled on stack creation failure. Default value: false. Valid values: true: disables rollback on stack creation failure. false: enables rollback on stack creation failure.
NotificationURLs	List	["http://127.XX.XX.1:8080/x", "http://127.0.XX.XX:8080/y"]	The callback URLs for receiving stack events.
Outputs	List	[{"Description": "Instance ID","OutputKey": "InstanceId","OutputValue": "i-a****"}]	The output parameters of the stack.
Parameters	Array of Parameter		The input parameters of the stack.
ParameterKey	String	InstanceType	The key of the parameter.
ParameterValue	String	ecs.cm4.6xlarge	The value of the parameter.
ParentStackId	String	4a6c9851-3b0f-4f5f-b4ca-a14bf692****	The ID of the parent stack.
RegionId	String	cn-beijing	The region ID of the stack. You can call the DescribeRegions operation to query the most recent region list.
Status	String	CREATE_COMPLETE	The status of the stack. Valid values: 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
StackId	String	4a6c9851-3b0f-4f5f-b4ca-a14bf691****	The ID of the stack.
StackName	String	MyStack	The name of the stack. 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.
UpdateTime	String	2019-08-01T04:07:39	The time when the stack was last updated. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.
StatusReason	String	Stack successfully created	The reason that the stack is in its current status.
TemplateDescription	String	Some description	The description of the stack.
TimeoutInMinutes	Integer	10	The timeout period that is specified for the stack creation request. Unit: minutes.
RequestId	String	B288A0BE-D927-4888-B0F7-B35EF84B6E6F	The ID of the request.
DeletionProtection	String	Enabled	Specifies whether to enable deletion protection on the stack. Valid values: Enabled: enables deletion protection on the stack. Disabled: disables deletion protection on the stack. You can release the stack by using the ROS console or the DeleteStack operation. Note The deletion protection property of a nested stack is the same as that of its root stack.
DriftDetectionTime	String	2020-02-27T07:47:47	The time when the last successful drift detection operation was initiated.
RamRoleName	String	test-role	The name of the RAM role. ROS assumes the specified RAM role to create the stack and call API operations by using the credentials of the role. All operations are performed under this role. If a RAM user is authorized to perform operations on the stack but does not have the permission to use the role, ROS still uses the role and grants the role the least privilege. If you do not specify this parameter, ROS uses the role previously associated with the stack. If no roles are available, ROS uses the temporary credentials generated from the credentials of your account. The RAM role name can be up to 64 characters in length.
RootStackId	String	4a6c9851-3b0f-4f5f-b4ca-a14bf692****	The ID of the root stack. This parameter is returned if the specified stack is a nested stack.
StackDriftStatus	String	IN_SYNC	The drift status of the stack in the last successful drift detection. Valid values: DRIFTED: The stack has drifted. NOT_CHECKED: No drift detection has been completed on the stack group. IN_SYNC: The stack is being synchronized.
StackType	String	ROS	The type of the stack. Valid values: ROS: indicates that the stack was created based on an ROS template. Terraform: indicates that the stack was created based on a Terraform template.

Examples

Sample requests

http(s)://ros.aliyuncs.com/? Action=GetStack
&RegionId=cn-hangzhou
&StackId=4a6c9851-3b0f-4f5f-b4ca-a14bf691****
&<Common request parameters>

Sample success responses

XML format

<GetStackResponse>
          <CreationTime>2019-08-01T04:07:39</CreationTime>
          <Description>No description</Description>
          <DisableRollback>false</DisableRollback>
          <NotificationURLs>http://127.0.XX.XX:8080/x</NotificationURLs>
          <NotificationURLs>http://127.0.XX.XX:8080/y</NotificationURLs>
          <Outputs>
                <Description>Instance ID</Description>
                <OutputKey>InstanceId</OutputKey>
                <OutputValue>i-a****</OutputValue>
          </Outputs>
          <Parameters>
                <ParameterKey>InstanceType</ParameterKey>
                <ParameterValue>ecs.cm4.6xlarge</ParameterValue>
          </Parameters>
          <RegionId>cn-hangzhou</RegionId>
          <StackId>4a6c9851-3b0f-4f5f-b4ca-a14bf691****</StackId>
          <StackName>MyStack</StackName>
          <Status>CREATE_COMPLETE</Status>
          <StatusReason>Stack successfully created</StatusReason>
          <TemplateDescription>Some description</TemplateDescription>
          <TimeoutInMinutes>10</TimeoutInMinutes>
          <UpdatedTime>2019-08-01T04:07:39</UpdatedTime>
          <ParentStackId>4a6c9851-3b0f-4f5f-b4ca-a14bf692****</ParentStackId>
          <DriftDetectionTime>2020-02-27T07:47:47</DriftDetectionTime>
          <StackDriftStatus>IN_SYNC</StackDriftStatus>
          <RamRoleName>test-role</RamRoleName>
          <DeletionProtection>Enabled</DeletionProtection>
          <RootStackId>4a6c9851-3b0f-4f5f-b4ca-a14bf692****</RootStackId>
          <StackType>ROS</StackType>
          <RequestId>B288A0BE-D927-4888-B0F7-B35EF84B6E6F</RequestId>
</GetStackResponse>

JSON format

{
    "CreationTime": "2019-08-01T04:07:39",
    "Description": "No description",
    "DisableRollback": false,
    "NotificationURLs": [
        "http://127.0.XX.XX:8080/x",
        "http://127.0.XX.XX:8080/y"
    ],
    "Outputs": [
        {
            "Description": "Instance ID",
            "OutputKey": "InstanceId",
            "OutputValue": "i-a****"
        }
    ],
    "Parameters": [
        {
            "ParameterKey": "InstanceType",
            "ParameterValue": "ecs.cm4.6xlarge"
        }
    ],
    "RegionId": "cn-hangzhou",
    "StackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf691****",
    "StackName": "MyStack",
    "Status": "CREATE_COMPLETE",
    "StatusReason": "Stack successfully created",
    "TemplateDescription": "Some description",
    "TimeoutInMinutes": 10,
    "UpdatedTime": "2019-08-01T04:07:39",
    "ParentStackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
    "DriftDetectionTime": "2020-02-27T07:47:47",
    "StackDriftStatus": "IN_SYNC",
    "RamRoleName": "test-role",
    "DeletionProtection": "Enabled",
    "RootStackId": "4a6c9851-3b0f-4f5f-b4ca-a14bf692****",
    "StackType": "ROS",
    "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F"
}

Error codes

For a list of error codes, visit the API Error Center.


HTTP status code	Error code	Error message	Description
404	StackNotFound	The Stack ({name}) could not be found.	The error message returned because the specified stack does not exist. name indicates the name or ID of the stack.