vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/rts/api-ref/rts_03_0022.html
Hasko, Vladimir 354bef10dd RTS API 0930 version (recreate of #289) 
Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2022-12-02 15:11:35 +00:00

560 lines
35 KiB
HTML
Raw Blame History

<a name="rts_03_0022"></a><a name="rts_03_0022"></a>
<h1 class="topictitle1">Previewing a Stack</h1>
<div id="body1511161465560"><div class="section" id="rts_03_0022__en-us_topic_0057973122_section3630399"><h4 class="sectiontitle">Function</h4><p id="rts_03_0022__en-us_topic_0057973122_p32730214">This API is used to preview a stack.</p>
</div>
<div class="section" id="rts_03_0022__en-us_topic_0057973122_section32673592"><h4 class="sectiontitle">URI</h4><p id="rts_03_0022__p76479013312">POST /v1/{project_id}/stacks/preview</p>
<p id="rts_03_0022__p148942964617">For details about the parameters, see <a href="#rts_03_0022__table1759528275">Table 1</a>.</p>
<div class="tablenoborder"><a name="rts_03_0022__table1759528275"></a><a name="table1759528275"></a><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0022__table1759528275" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rts_03_0022__row26011272716"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.1"><p id="rts_03_0022__p623302764616"><strong id="rts_03_0022__b149517142109">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.2"><p id="rts_03_0022__p92386277468"><strong id="rts_03_0022__b081718593102">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.3"><p id="rts_03_0022__p72423275465"><strong id="rts_03_0022__b1892330141114">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.4"><p id="rts_03_0022__p624719271465"><strong id="rts_03_0022__b175012619115">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0022__row10601725277"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0022__p625562794612">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rts_03_0022__p1126062744618">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0022__p1726662744617">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0022__p1727018275468">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rts_03_0022__en-us_topic_0057973122_section25626875"><h4 class="sectiontitle">Request Parameter</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0022__en-us_topic_0057973122_table4943390911314" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0022__en-us_topic_0057973122_row6551718411314"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.1.6.1.1"><p id="rts_03_0022__p17493122142817"><strong id="rts_03_0022__b116161931114">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.1.6.1.2"><p id="rts_03_0022__p1887419221879"><strong id="rts_03_0022__b1812522214115">In</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.6.1.3"><p id="rts_03_0022__p16493922112813"><strong id="rts_03_0022__b053142521111">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.6.1.4"><p id="rts_03_0022__p94935225284"><strong id="rts_03_0022__b193871726101119">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44%" id="mcps1.3.3.2.1.6.1.5"><p id="rts_03_0022__p1549342213284"><strong id="rts_03_0022__b13857203381110">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0022__en-us_topic_0057973122_row4356524411314"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.6.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p687852811322">stack_name</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.6.1.2 "><p id="rts_03_0022__p394012418417">body</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p2028992511322">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p3287125111322">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.3.2.1.6.1.5 "><p id="rts_03_0022__en-us_topic_0057973122_p4532564911322">Specifies the stack name.</p>
<ul id="rts_03_0022__ul45291469124"><li id="rts_03_0022__li1852911617120">The value can contain only uppercase letters, lowercase letters, digits, hyphens (-), periods (.), and underscores (_).</li><li id="rts_03_0022__li2147659191213">The value must start with an uppercase letter or a lowercase letter.</li><li id="rts_03_0022__li10293495134">The value can contain 1 to 255 characters.</li></ul>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row4669483711314"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.6.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p2483709111322">template_url</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.6.1.2 "><p id="rts_03_0022__p10940122417415">body</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p6564734511322">String</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p1583473211322">No</p>
</td>
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.3.2.1.6.1.5 "><p id="rts_03_0022__en-us_topic_0057973122_p754489111322">Specifies the template URL. You cannot select a template using the URL temporarily.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row1869491611314"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.6.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p6440780711322">template</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.6.1.2 "><p id="rts_03_0022__p1294002418418">body</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p4964984011322">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p6221409811322">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.3.2.1.6.1.5 "><p id="rts_03_0022__en-us_topic_0057973122_p617716411322">Specifies the template. The template content must use the YAML syntax.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row1496430011314"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.6.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p685920411322">files</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.6.1.2 "><p id="rts_03_0022__p10940024194112">body</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p1872467511322">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p4030370211322">No</p>
</td>
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.3.2.1.6.1.5 "><p id="rts_03_0022__en-us_topic_0057973122_p4337443811322">Specifies the files referenced in the environment.</p>
</td>
</tr>
<tr id="rts_03_0022__row41337528138"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.6.1.1 "><p id="rts_03_0022__p9135852121320">disable_rollback</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.6.1.2 "><p id="rts_03_0022__p1494052418415">body</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.3 "><p id="rts_03_0022__p913513527134">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.4 "><p id="rts_03_0022__p1213525281317">No</p>
</td>
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.3.2.1.6.1.5 "><p id="rts_03_0022__p613515528137">Specifies whether to perform a rollback when stack creation fails.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row4805106011314"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.1.6.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p1169054111322">parameters</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.6.1.2 "><p id="rts_03_0022__p59406241419">body</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p740977911322">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p6332123311322">No</p>
</td>
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.3.2.1.6.1.5 "><p id="rts_03_0022__en-us_topic_0057973122_p2874628811322">Specifies parameter information of the stack.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rts_03_0022__en-us_topic_0057973122_section29315290"><h4 class="sectiontitle">Response Parameter</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0022__table1160115752114" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0022__row96285792113"><th align="left" class="cellrowborder" valign="top" width="18.39%" id="mcps1.3.4.2.1.5.1.1"><p id="rts_03_0022__p10737181684115"><strong id="rts_03_0022__b1451020319192">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.940000000000001%" id="mcps1.3.4.2.1.5.1.2"><p id="rts_03_0022__p10741101619416"><strong id="rts_03_0022__b43001562196">In</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.09%" id="mcps1.3.4.2.1.5.1.3"><p id="rts_03_0022__p0746191610413"><strong id="rts_03_0022__b43362916191">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.580000000000005%" id="mcps1.3.4.2.1.5.1.4"><p id="rts_03_0022__p0754716144111"><strong id="rts_03_0022__b2131212171912">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0022__row5621578214"><td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0022__p3658190142210">stack</p>
</td>
<td class="cellrowborder" valign="top" width="14.940000000000001%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0022__p83331638134518">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.09%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0022__p1066314019225">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="50.580000000000005%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0022__p767219012210">Specifies the stack object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rts_03_0022__p1233914214233"><strong id="rts_03_0022__b11219132181911">stack</strong> structure information</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0022__en-us_topic_0057973122_table21028423" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0022__en-us_topic_0057973122_row27762594"><th align="left" class="cellrowborder" valign="top" width="18.6%" id="mcps1.3.4.4.1.5.1.1"><p id="rts_03_0022__p19538715104414"><strong id="rts_03_0022__b13931222199">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.120000000000001%" id="mcps1.3.4.4.1.5.1.2"><p id="rts_03_0022__p054301516441"><strong id="rts_03_0022__b4410162711918">In</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.28%" id="mcps1.3.4.4.1.5.1.3"><p id="rts_03_0022__p15546515194419"><strong id="rts_03_0022__b1235813017199">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.1.5.1.4"><p id="rts_03_0022__p4555201504411"><strong id="rts_03_0022__b101661733181920">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0022__en-us_topic_0057973122_row17639389"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p19504393">parent</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p5472113518428">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p36351961">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p314502">Specifies the UUID of the parent stack (for a nested stack).</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row2830526"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p27946073">id</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p16472735114214">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p49039453">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p27957437">Specifies the stack UUID.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row50290344"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p46986044">links</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p1947243574218">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p47773213">List &lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p41656035">Specifies the stack URL list.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row39360002"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p34043626">stack_name</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p16472103518428">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p6070306">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p31722659">Specifies the stack name.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row17068479"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p40369572">description</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p1047253517422">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p48709885">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p13148205">Describes the stack.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row51224983"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p55582963">template_description</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p8218145217447">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p5926151">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p25450106">Describes the template defined by the stack.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row27724363"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p31080936">timeout_mins</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p1322675284419">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p34527906">Int</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p45177739">Specifies the timeout duration.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row3946468"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p51228509">disable_rollback</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p1923114527447">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p55868534">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p4836521">Specifies whether to perform a rollback when stack creation fails.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row43528691"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p36163121">capabilities</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p1923655274418">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p43531699">List</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p63265957">Specifies the list of stack capacities.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row32522706"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p17093519">creation_time</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p11242652114411">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p42397780">Date Time</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p5597720">Specifies the time when the stack was created.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row50379488"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p54206759">notification_topics</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p12761056154417">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p28671321">List</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p6395812">Specifies the message notification list of the stack.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row57562312"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p32035697">updated_time</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p881156134419">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p44754699">Date Time</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p34305585">Specifies the last time when the stack was updated.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row40314810"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p44274160">stack_owner</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p12861056114414">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p29437244">Sting</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p65556783">Specifies the name of the stack owner.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row53140143"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p9384301">parameters</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p792175674414">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p21930883">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p7122137">Specifies parameters defined by the stack.</p>
</td>
</tr>
<tr id="rts_03_0022__en-us_topic_0057973122_row64099240"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0022__en-us_topic_0057973122_p24655927">resources</p>
</td>
<td class="cellrowborder" valign="top" width="15.120000000000001%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0022__p119745618445">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0022__en-us_topic_0057973122_p50973059">List &lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0022__en-us_topic_0057973122_p30770799">Specifies the stack resource list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rts_03_0022__en-us_topic_0057973122_section62511020"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="rts_03_0022__en-us_topic_0057973122_screen139860121145">POST /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/preview
{
"files": {},
"disable_rollback": true,
"parameters": {
"flavor": "m1.heat"
},
"stack_name": "teststack",
"template": {
"heat_template_version": "2013-05-23",
"description": "Simple template to test heat commands",
"parameters": {
"flavor": {
"default": "m1.tiny",
"type": "string"
}
},
"resources": {
"hello_world": {
"type": "OS::Nova::Server",
"properties": {
"key_name": "heat_key",
"flavor": {
"get_param": "flavor"
},
"image": "40be8d1a-3eb9-40de-8abd-43237517384f",
"user_data": "#!/bin/bash -xv\necho \"hello world\" &amp;gt; /root/hello-world.txt\n"
}
}
}
},
"timeout_mins": 60
}</pre>
</div>
<div class="section" id="rts_03_0022__en-us_topic_0057973122_section25728276"><h4 class="sectiontitle">Response Example</h4><pre class="screen" id="rts_03_0022__en-us_topic_0057973122_screen2007367311450">{
"stack": {
"capabilities": [],
"creation_time": "2015-01-31T15:12:36Z",
"description": "HOT template for Nova Server resource.\n",
"disable_rollback": true,
"id": "None",
"links": [
{
"href": "http://x.x.x.x:8004/v1/6e18cc2bdbeb48a5basad2dc499f6804/stacks/test_stack/None",
"rel": "self"
}
],
"notification_topics": [],
"parameters": {
"OS::project_id": "6e18cc2bdbeb48a5basad2dc499f6804",
"OS::stack_id": "None",
"OS::stack_name": "teststack",
"admin_user": "cloud-user",
"flavor": "m1.small",
"image": "F20-cfg",
"key_name": "heat_key",
"server_name": "MyServer"
},
"parent": null,
"resources": [
{
"attributes": {},
"description": "",
"metadata": {},
"physical_resource_id": "",
"properties": {
"description": "Ping and SSH",
"name": "the_sg",
"rules": [
{
"direction": "ingress",
"ethertype": "IPv4",
"port_range_max": null,
"port_range_min": null,
"protocol": "icmp",
"remote_group_id": null,
"remote_ip_prefix": null,
"remote_mode": "remote_ip_prefix"
},
{
"direction": "ingress",
"ethertype": "IPv4",
"port_range_max": 65535,
"port_range_min": 1,
"protocol": "tcp",
"remote_group_id": null,
"remote_ip_prefix": null,
"remote_mode": "remote_ip_prefix"
},
{
"direction": "ingress",
"ethertype": "IPv4",
"port_range_max": 65535,
"port_range_min": 1,
"protocol": "udp",
"remote_group_id": null,
"remote_ip_prefix": null,
"remote_mode": "remote_ip_prefix"
}
]
},
"required_by": [
"server1"
],
"resource_action": "INIT",
"resource_identity": {
"path": "/resources/the_sg_res",
"stack_id": "None",
"stack_name": "teststack",
"tenant": "6e18cc2bdbeb48a5b3cad2dc499f6804"
},
"resource_name": "the_sg_res",
"resource_status": "COMPLETE",
"resource_status_reason": "",
"resource_type": "OS::Neutron::SecurityGroup",
"stack_identity": {
"path": "",
"stack_id": "None",
"stack_name": "teststack",
"tenant": "6e18cc2bdbeb48a5b3cad2dc499f6804"
},
"stack_name": "teststack",
"updated_time": "2015-01-31T15:12:36Z"
},
{
"attributes": {
"accessIPv4": "",
"accessIPv6": "",
"addresses": "",
"console_urls": "",
"first_address": "",
"instance_name": "",
"name": "MyServer",
"networks": "",
"show": ""
},
"description": "",
"metadata": {},
"physical_resource_id": "",
"properties": {
"admin_pass": null,
"admin_user": "cloud-user",
"availability_zone": null,
"block_device_mapping": null,
"config_drive": null,
"diskConfig": null,
"flavor": "m1.small",
"flavor_update_policy": "RESIZE",
"image": "F20-cfg",
"image_update_policy": "REPLACE",
"key_name": "heat_key",
"metadata": {
"ha_stack": "None"
},
"name": "MyServer",
"networks": [
{
"fixed_ip": null,
"network": "private",
"port": null,
"uuid": null
}
],
"personality": {},
"reservation_id": null,
"scheduler_hints": null,
"security_groups": [
"None"
],
"software_config_transport": "POLL_SERVER_CFN",
"user_data": "",
"user_data_format": "HEAT_CFNTOOLS"
},
"required_by": [],
"resource_action": "INIT",
"resource_identity": {
"path": "/resources/hello_world",
"stack_id": "None",
"stack_name": "teststack",
"tenant": "6e18cc2bdbeb48a3433cad2dc499sdf32234"
},
"resource_name": "hello_world",
"resource_status": "COMPLETE",
"resource_status_reason": "",
"resource_type": "OS::Nova::Server",
"stack_identity": {
"path": "",
"stack_id": "None",
"stack_name": "teststack",
"tenant": "6e18cc2bdbeb48a3433cad2dc499sdf32234"
},
"stack_name": "teststack",
"updated_time": "2015-01-31T15:12:36Z"
}
],
"stack_name": "test_stack",
"stack_owner": "admin",
"template_description": "HOT template for Nova Server resource.\n",
"timeout_mins": null,
"updated_time": null
}
}</pre>
</div>
<div class="section" id="rts_03_0022__en-us_topic_0057973122_section30227898"><h4 class="sectiontitle">Return Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0022__en-us_topic_0057973117_table40445519194057" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Normal return code</caption><thead align="left"><tr id="rts_03_0022__en-us_topic_0057973117_row42419326194057"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.7.2.2.4.1.1"><p id="rts_03_0022__en-us_topic_0057973117_p13413377194057"><strong id="rts_03_0022__b2876940264">Return Code</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.7.2.2.4.1.2"><p id="rts_03_0022__en-us_topic_0057973117_p12741761194057"><strong id="rts_03_0022__en-us_topic_0057973140_b84235270615814_1">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51%" id="mcps1.3.7.2.2.4.1.3"><p id="rts_03_0022__en-us_topic_0057973117_p25449701194057"><strong id="rts_03_0022__en-us_topic_0057973140_b842352706193020">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0022__en-us_topic_0057973117_row48159894194057"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.2.2.4.1.1 "><p id="rts_03_0022__en-us_topic_0057973117_p8637307194057">201</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.2.2.4.1.2 "><p id="rts_03_0022__en-us_topic_0057973117_p28533244194057">Created</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.2.2.4.1.3 "><p id="rts_03_0022__en-us_topic_0057973117_p29491459194057">The resource has been created and is ready for use.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0022__table19512103414" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Error return code</caption><thead align="left"><tr id="rts_03_0022__row16955110342"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.7.3.2.4.1.1"><p id="rts_03_0022__p129561510144"><strong id="rts_03_0022__b14562155022311">Return Code</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.7.3.2.4.1.2"><p id="rts_03_0022__p4959810444"><strong id="rts_03_0022__b372233500">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51%" id="mcps1.3.7.3.2.4.1.3"><p id="rts_03_0022__p9959161020418"><strong id="rts_03_0022__b1892635879">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0022__row179609103411"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0022__p896118101840">400</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0022__p1296211015416">Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0022__p9963110146">The server failed to process the request.</p>
</td>
</tr>
<tr id="rts_03_0022__row181330274199"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0022__p18134027201912">401</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0022__p1713419274191">Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0022__p11134162718196">Authorization failed.</p>
</td>
</tr>
<tr id="rts_03_0022__row16531631121913"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0022__p156541031121913">409</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0022__p12654183112194">Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0022__p1253585513244">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="rts_03_0022__row196097477276"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0022__p19789174972712">500</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0022__p779364918272">Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0022__p196546319198">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rts_03_0019.html">Stack Management</a></div>
</div>
</div>
View Git Blame Copy Permalink