All Products
Search

This Product

    Preview a stack

    Document Center
    Download PDF

    Preview a stack

    Last Updated: Mar 22, 2019

    Call /stacks/preview by POST to preview the stack information of the specified template.

    Request parameters

    Name Location Type Required Description
    x-acs-region-id header String Yes Region where the stack is to be created. See ROS region list.
    Name body String Yes Name of the stack, which must comply with the regular expression ^[a-zA-Z][a-zA-Z0-9_.-]*$. It can contain up to 255 characters.
    Template body JSON Yes Template is in JSON format. Currently, the maximum template size is 512 KB by default. The parameter value is adjustable.
    Parameters body JSON Yes Parameters required to create the stack. The keys must be specified in the template.
    DisableRollback body Boolean No Whether to disable rollback when the stack fails to be created. “True” indicates that rollback is disabled. That is, rollback is not performed when the stack creation fails. “False” indicates that rollback is not disabled. That is, rollback is performed when the stack creation fails.
    TimeoutMins body Integer Yes Timeout time for stack creation, in minutes. The default value is 60.

    Returned parameters

    Name Parameter type Description
    Description String Stack description.
    Updated String Update time, which follows the ISO8601 standard and uses UTC time. The format is YYYY-MM-DDThh:mm:ssZ.
    Parameters JSON Stack parameter set in JSON format.
    Created String Stack creation time, which follows the ISO8601 standard and uses UTC time. The format is YYYY-MM-DDThh:mm:ssZ.
    Region String Region where the stack is located.
    TemplateDescription String Template description.
    Webhook String Custom callback function.
    Id String Stack ID.
    Resources JSON Detailed information about stack resources, which is a resource set in JSON format.
    Name String Stack name.
    DisableRollback Boolean Whether to disable rollback when the stack fails to be created. “True” indicates that rollback is disabled. That is, rollback is not performed when the stack creation fails. “False” indicates that rollback is not disabled. That is, rollback is performed when the stack creation fails.
    TimeoutMins Integer Timeout time for stack creation, in minutes.

    Error codes

    Error code Description HTTP status code Meaning
    InternalError Server error. 500 Server-side unknown exception.
    NotSupported %(feature)s is not supported. 404 Unsupported parameter.
    InvalidTemplateVersion Template version was not provided. 400 Invalid template version.
    InvalidTemplateVersion Ambiguous versions (%s). 400 Invalid template version.
    InvalidTemplateSection The Parameter (%(key)s) has no attributes. 400 Incorrect template attributes.
    StackValidationFailed Each Resource must contain a Type key. 400 Resources must contain the Type attribute.
    StackValidationFailed Resources must contain Resource. Found a [%s] instead. 400 Resources must contain Resource.
    StackValidationFailed Invalid deletion policy “%s”. 400 Invalid deletion policy.
    StackValidationFailed “%s” deletion policy not supported. 400 Invalid deletion policy.
    StackValidationFailed Unknown Property %s. 400 Unknown property.
    InvalidSchemaError Property %(prop)s: %(ua)s and %(im)s cannot both be True. 400 Incorrect template format.

    Example

    Request example

    1. POST http://ros.aliyuncs.com/stacks/preview HTTP/1.1
    2. x-acs-signature-method: HMAC-SHA1
    3. Authorization: acs <AccessKeyId>:<signature>
    4. Date: Fri, 11 Sep 2015 05:28:47 GMT
    5. Content-MD5: 4eCVDLNDI0GRJMiZ6mLmgw==
    6. x-acs-signature-version: 1.0
    7. Accept: application/octet-stream
    8. Content-Type: application/json;charset=utf-8
    9. x-acs-version: 2015-09-01
    10. Cache-Control: no-cache
    11. Pragma: no-cache
    12. x-acs-region-id:cn-beijing
    13. Host: ros.aliyuncs.com
    14. Connection: keep-alive
    15. Content-Length: 502
    17. {
    18.   “Name”: “<stack name>”,
    19.   “Parameters”:
    20.   {
    21.     “key”: “value”
    22.   },
    23.   “Template”:<template text>,
    24.   “DisableRollback”: true,
    25.   “TimeoutMins”: 15
    26. }

    Response example

    1. HTTP/1.1 201 Created
    2. Date: Fri, 11 Sep 2015 05:28:48 GMT
    3. Content-Type: application/json
    4. Content-Length: 155
    5. Connection: close
    6. Access-Control-Allow-Origin: *
    7. Access-Control-Allow-Methods: POST, GET, OPTIONS
    8. Access-Control-Allow-Headers: X-Requested-With, X-Sequence, _aop_secret, _aop_signature
    9. Access-Control-Max-Age: 172800
    10. X-Acs-Request-Id: 14EB3BE2-B4A8-4F84-BD6E-52F222DDB66C
    11. Server: Jetty(7.2.2.v20101205)
    13. {
    14.     "Updated":null,
    15.     "Description":"No description",
    16.     "Parameters":{
    17.         "ALIYUN::StackId":"None",
    18.         "ALIYUN::StackName":"update_test_0040",
    19.         "ALIYUN::Region":"cn-beijing"
    20.     },
    21.     "Created":"2017-01-17T07:01:10.437639",
    22.     "Region":"cn-beijing",
    23.     "TemplateDescription":"No description",
    24.     "Webhook":null,
    25.     "Id":"None",
    26.     "DisableRollback":false,
    27.     "TimeoutMins":120,
    28.     "Resources":[
    29.         {
    30.             "UpdatedTime":null,
    31.             "StackIdentity":{
    32.                 "StackName":"update_test_0040",
    33.                 "StackId":"None",
    34.                 "Region":"cn-beijing",
    35.                 "Tenant":"175458090349****",
    36.                 "Path":""
    37.             },
    38.             "ResourceStatus":"COMPLETE",
    39.             "Description":"",
    40.             "ResourceData":null,
    41.             "ResourceStatusReason":"",
    42.             "ResourceAction":"INIT",
    43.             "PhysicalResourceId":"",
    44.             "DeletedTime":null,
    45.             "StackName":"update_test_0040",
    46.             "ResourceType":"ALIYUN::ECS::InstanceGroupClone",
    47.             "RequiredBy":[
    49.             ],
    50.             "Attributes":{
    51.                 "OrderId":null,
    52.                 "InnerIps":null,
    53.                 "PrivateIps":null,
    54.                 "ZoneIds":null,
    55.                 "PublicIps":null,
    56.                 "InstanceIds":null
    57.             },
    58.             "CreatedTime":null,
    59.             "ResourceName":"WebServer",
    60.             "ResourceIdentity":{
    61.                 "StackName":"update_test_0040",
    62.                 "StackId":"None",
    63.                 "Region":"cn-beijing",
    64.                 "Tenant":"175458090349****",
    65.                 "Path":"/resources/WebServer"
    66.             },
    67.             "Properties":{
    68.                 "AutoReleaseTime":null,
    69.                 "DiskMappings":null,
    70.                 "LoadBalancerIdToAttach":null,
    71.                 "Description":null,
    72.                 "BackendServerWeight":100,
    73.                 "Tags":null,
    74.                 "MinAmount":1,
    75.                 "SecurityGroupId":null,
    76.                 "ZoneId":null,
    77.                 "InternetMaxBandwidthOut":null,
    78.                 "ImageId":null,
    79.                 "SourceInstanceId":"i-2ze5q7nkum5974w67jhr",
    80.                 "Password":"Test****",
    81.                 "InstanceName":null,
    82.                 "MaxAmount":1
    83.             },
    84.             "Metadata":{
    86.             }
    87.         }
    88.     ],
    89.     "Name":"update_test_0040"
    90. }
    Free Trial Free Trial