doc-exports/docs/rts/api-ref/rts_03_0025.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

377 lines
28 KiB
HTML

<a name="rts_03_0025"></a><a name="rts_03_0025"></a>
<h1 class="topictitle1">Querying Details of a Stack</h1>
<div id="body1511161465560"><div class="section" id="rts_03_0025__en-us_topic_0057973125_section15571009"><h4 class="sectiontitle">Function</h4><p id="rts_03_0025__en-us_topic_0057973125_p53063747">This API is used to query details of a stack.</p>
</div>
<div class="section" id="rts_03_0025__en-us_topic_0057973125_section5921358"><h4 class="sectiontitle">URI</h4><p id="rts_03_0025__p76479013312">GET /v1/{project_id}/stacks/{stack_name}/{stack_id}</p>
<div class="note" id="rts_03_0025__note5370731163911"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="rts_03_0025__p16370153133917">This API supports redirection. During the calling, you can specify only <strong id="rts_03_0025__b15118144423917">stack_name</strong> or <strong id="rts_03_0025__b1667664616393">stack_id</strong>.</p>
</div></div>
<p id="rts_03_0025__p12258628184915">For details about the parameters, see <a href="#rts_03_0025__table1759528275">Table 1</a>.</p>
<div class="tablenoborder"><a name="rts_03_0025__table1759528275"></a><a name="table1759528275"></a><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0025__table1759528275" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rts_03_0025__row26011272716"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.5.2.5.1.1"><p id="rts_03_0025__p17762534144716"><strong id="rts_03_0025__b19909141494115">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.5.2.5.1.2"><p id="rts_03_0025__p376433420478"><strong id="rts_03_0025__b12216171914418">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.5.2.5.1.3"><p id="rts_03_0025__p15766123474714"><strong id="rts_03_0025__b17312182014117">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.5.2.5.1.4"><p id="rts_03_0025__p147683349474"><strong id="rts_03_0025__b561062444111">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0025__row10601725277"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.1 "><p id="rts_03_0025__p14468758">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.2 "><p id="rts_03_0025__p1581811351277">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.3 "><p id="rts_03_0025__p31118786">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.4 "><p id="rts_03_0025__p37593705">Specifies the project ID.</p>
</td>
</tr>
<tr id="rts_03_0025__row161097438473"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.1 "><p id="rts_03_0025__p129746567332">stack_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.2 "><p id="rts_03_0025__p127445853413">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.3 "><p id="rts_03_0025__p167462087343">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.4 "><p id="rts_03_0025__p2750168173419">Specifies the stack name.</p>
</td>
</tr>
<tr id="rts_03_0025__row131851844124918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.1 "><p id="rts_03_0025__p1859881513364">stack_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.2 "><p id="rts_03_0025__p174332483611">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.3 "><p id="rts_03_0025__p13461724163619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.4 "><p id="rts_03_0025__p134992463611">Specifies the stack UUID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rts_03_0025__en-us_topic_0057973125_section53292223"><h4 class="sectiontitle">Request Parameter</h4><p id="rts_03_0025__p195581137103616">N/A</p>
</div>
<div class="section" id="rts_03_0025__en-us_topic_0057973125_section9867967"><h4 class="sectiontitle">Response Parameter</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0025__table1160115752114" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0025__row96285792113"><th align="left" class="cellrowborder" valign="top" width="15.478452154784522%" id="mcps1.3.4.2.1.5.1.1"><p id="rts_03_0025__p239416162216"><strong id="rts_03_0025__b756018513412">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.66833316668333%" id="mcps1.3.4.2.1.5.1.2"><p id="rts_03_0025__p65991078374"><strong id="rts_03_0025__b209351455204112">In</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.66833316668333%" id="mcps1.3.4.2.1.5.1.3"><p id="rts_03_0025__p17396126122218"><strong id="rts_03_0025__b10216959104110">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.18488151184882%" id="mcps1.3.4.2.1.5.1.4"><p id="rts_03_0025__p114046632218"><strong id="rts_03_0025__b982411216428">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0025__row5621578214"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0025__p3658190142210">stack</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0025__p359997173719">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0025__p1066314019225">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0025__p767219012210">Specifies the stack object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rts_03_0025__p14815501279"><strong id="rts_03_0025__b134891014426">stack</strong> structure information</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0025__en-us_topic_0057973125_table50168316" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0025__en-us_topic_0057973125_row55275058"><th align="left" class="cellrowborder" valign="top" width="15.478452154784522%" id="mcps1.3.4.4.1.5.1.1"><p id="rts_03_0025__p13701251185014"><strong id="rts_03_0025__b4930101110421">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.66833316668333%" id="mcps1.3.4.4.1.5.1.2"><p id="rts_03_0025__p13704145119507"><strong id="rts_03_0025__b5444516114217">In</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.66833316668333%" id="mcps1.3.4.4.1.5.1.3"><p id="rts_03_0025__p3705151185017"><strong id="rts_03_0025__b1429531919424">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.18488151184882%" id="mcps1.3.4.4.1.5.1.4"><p id="rts_03_0025__p1371214511507"><strong id="rts_03_0025__b14244142212429">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0025__row196810364234"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__en-us_topic_0057973125_p15167947">disable_rollback</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p179419223374">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__en-us_topic_0057973125_p20644201">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__en-us_topic_0057973125_p20921680">Specifies whether to perform a rollback when stack creation fails.</p>
</td>
</tr>
<tr id="rts_03_0025__row4684104472312"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__en-us_topic_0057973125_p57340893">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p194192212377">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__en-us_topic_0057973125_p14100779">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__en-us_topic_0057973125_p39197567">Describes the stack.</p>
</td>
</tr>
<tr id="rts_03_0025__row9976155510519"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__p17977195512514">parent</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p1197716556514">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__p109771455145113">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__p89771855135118">Specifies the ID of the parent stack if the stack is the nesting type.</p>
</td>
</tr>
<tr id="rts_03_0025__row134631359185111"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__p2463205917519">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p1346313594517">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__p11463185975118">Array</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__p946415597514">Specifies whether to perform a rollback when stack creation fails.</p>
</td>
</tr>
<tr id="rts_03_0025__row733725112420"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__en-us_topic_0057973125_p18192809">parameters</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p1694172233716">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__en-us_topic_0057973125_p64331453">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__en-us_topic_0057973125_p31020730">Specifies parameter information of the stack.</p>
</td>
</tr>
<tr id="rts_03_0025__row1298101842414"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__en-us_topic_0057973125_p3338892">stack_status_reason</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p694722143716">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__en-us_topic_0057973125_p2014806">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__en-us_topic_0057973125_p65806680">Describes the stack operation.</p>
</td>
</tr>
<tr id="rts_03_0025__row1498201842414"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__en-us_topic_0057973125_p55194683">stack_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p139472273713">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__en-us_topic_0057973125_p41584316">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__en-us_topic_0057973125_p37170869">Specifies the stack name.</p>
</td>
</tr>
<tr id="rts_03_0025__row16399104655319"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__p13399144625319">stack_user_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p33995462537">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__p6399114625320">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__p439944665313">This is a reserved parameter.</p>
</td>
</tr>
<tr id="rts_03_0025__row1598251819244"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__p10982151812244">outputs</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p39492216372">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__p1098291817245">List</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__p169828183245">Specifies the output stack list.</p>
</td>
</tr>
<tr id="rts_03_0025__row25417237263"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__en-us_topic_0057973125_p3959432">creation_time</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p094622173716">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__en-us_topic_0057973125_p52278570">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__en-us_topic_0057973125_p6296031">Specifies the time when the stack was created.</p>
</td>
</tr>
<tr id="rts_03_0025__row694173642612"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__en-us_topic_0057973125_p53759497">links</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p994172203718">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__en-us_topic_0057973125_p59552004">List &lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__en-us_topic_0057973125_p12893279">Specifies the stack URL list.</p>
</td>
</tr>
<tr id="rts_03_0025__row14367125817267"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__p636745872616">capabilities</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p5947225376">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__p1736745819268">List</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__p1367175812617">Specifies the list of stack capacities.</p>
</td>
</tr>
<tr id="rts_03_0025__row112293163271"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__p112291316182717">notification_topics</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p1848310575387">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__p13229111662714">List</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__p9229151662718">Specifies the message notification list of the stack.</p>
</td>
</tr>
<tr id="rts_03_0025__row522917160279"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__en-us_topic_0057973125_p65534095">timeout_mins</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p10488175773817">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__en-us_topic_0057973125_p6661458">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__en-us_topic_0057973125_p17956409">Specifies the timeout duration.</p>
</td>
</tr>
<tr id="rts_03_0025__row16229716132718"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__en-us_topic_0057973125_p52691811">stack_status</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p7490657183815">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__en-us_topic_0057973125_p40178308">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__en-us_topic_0057973125_p6264391">Specifies the stack status.</p>
</td>
</tr>
<tr id="rts_03_0025__row1451911514559"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__p15191955555">stack_owner</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p1251995175516">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__p4519205125516">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__p1451915185519">This is a reserved parameter.</p>
</td>
</tr>
<tr id="rts_03_0025__en-us_topic_0057973125_row23587534"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__en-us_topic_0057973125_p26404315">updated_time</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p1449310571389">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__en-us_topic_0057973125_p58374766">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__en-us_topic_0057973125_p6556786">Specifies the time when the stack was updated.</p>
</td>
</tr>
<tr id="rts_03_0025__en-us_topic_0057973125_row37964118"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__en-us_topic_0057973125_p31542065">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p34961757183813">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__en-us_topic_0057973125_p4770510">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__en-us_topic_0057973125_p26587856">Specifies the stack UUID.</p>
</td>
</tr>
<tr id="rts_03_0025__en-us_topic_0057973125_row66102371"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0025__en-us_topic_0057973125_p3994012">template_description</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0025__p649985733814">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0025__en-us_topic_0057973125_p55079576">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.18488151184882%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0025__en-us_topic_0057973125_p62980318">Describes the template.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rts_03_0025__en-us_topic_0057973125_section21702846"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="rts_03_0025__en-us_topic_0057973125_screen3159121417145">GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306</pre>
</div>
<div class="section" id="rts_03_0025__en-us_topic_0057973125_section61107894"><h4 class="sectiontitle">Response Example</h4><pre class="screen" id="rts_03_0025__en-us_topic_0057973125_screen5676582911658">{
"stack": {
"disable_rollback": true,
"description": "Hello world HOT template that just defines a single compute instance. Contains just base features to verify base HOT support.\n",
"parent": null,
"tags": null,
"parameters": {
"Network": "3f8713b7-8aea-4b0f-a70b-98d4e1d6251f",
"OS::stack_name": "HeatStack",
"ImageId": "68e22196-a4aa-4946-85c3-75f4957e667a",
"OS::stack_id": "c89c4bb3-96cb-4a55-aafa-076a7939a306",
"KeyName": "heat-key",
"OS::project_id": "95d02433133a4c0a87ba6967474a2ad3",
"InstanceType": "m1.tiny"
},
"stack_user_project_id": "95d02433133a4c0a87ba6967474a2ad3",
"stack_status_reason": "Stack create completed successfully",
"stack_name": "HeatStack",
"outputs": [],
"creation_time": "2014-01-26T17:21:35Z",
"links": [
{
"href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306",
"rel": "self"
}
],
"capabilities": [],
"notification_topics": [],
"timeout_mins": 60,
"stack_status": "CREATE_COMPLETE",
"stack_owner": null,
"updated_time": "2014-01-26T17:21:41Z",
"id": "c89c4bb3-96cb-4a55-aafa-076a7939a306",
"template_description": "Hello world HOT template that just defines a single compute instance. Contains just base features to verify base HOT support.\n"
}
}</pre>
</div>
<div class="section" id="rts_03_0025__en-us_topic_0057973125_section13100134"><h4 class="sectiontitle">Return Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0025__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_0025__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_0025__en-us_topic_0057973117_p13413377194057"><strong id="rts_03_0025__b731785218616">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_0025__en-us_topic_0057973117_p12741761194057"><strong id="rts_03_0025__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_0025__en-us_topic_0057973117_p25449701194057"><strong id="rts_03_0025__en-us_topic_0057973140_b842352706193020">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0025__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_0025__en-us_topic_0057973124_p9904457194351">200</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.2.2.4.1.2 "><p id="rts_03_0025__en-us_topic_0057973124_p64063566194351">OK</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.2.2.4.1.3 "><p id="rts_03_0025__en-us_topic_0057973124_p21766343194351">Request was successful.</p>
</td>
</tr>
<tr id="rts_03_0025__row18143162895914"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.2.2.4.1.1 "><p id="rts_03_0025__p52068209206">302</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.2.2.4.1.2 "><p id="rts_03_0025__p52061120172014">Found</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.2.2.4.1.3 "><p id="rts_03_0025__p620662018205">The response is about redirection. The response header usually contains a location value that allows you to track the real location of the resource.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0025__table19512103414" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Error return code</caption><thead align="left"><tr id="rts_03_0025__row16955110342"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.7.3.2.4.1.1"><p id="rts_03_0025__p129561510144"><strong id="rts_03_0025__b1552942884813">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_0025__p4959810444"><strong id="rts_03_0025__b956007905">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_0025__p9959161020418"><strong id="rts_03_0025__b359171417">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0025__row179609103411"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0025__p896118101840">400</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0025__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_0025__p9963110146">The server failed to process the request.</p>
</td>
</tr>
<tr id="rts_03_0025__row181330274199"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0025__p18134027201912">401</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0025__p1713419274191">Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0025__p11134162718196">Authorization failed.</p>
</td>
</tr>
<tr id="rts_03_0025__row16531631121913"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0025__en-us_topic_0057973122_p5338333194217">404</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0025__p125520290312">Not found</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0025__en-us_topic_0057973122_p29751790194217">The requested resources are not found.</p>
</td>
</tr>
<tr id="rts_03_0025__row196097477276"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0025__p19789174972712">500</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0025__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_0025__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>