forked from docs/doc-exports
Hasko, Vladimir
354bef10dd
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>
212 lines
15 KiB
HTML
212 lines
15 KiB
HTML
<a name="rts_03_0043"></a><a name="rts_03_0043"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Stack Template</h1>
|
|
<div id="body1511161465561"><div class="section" id="rts_03_0043__en-us_topic_0057973145_section59686491"><h4 class="sectiontitle">Function</h4><p id="rts_03_0043__en-us_topic_0057973145_p14512406">This API is used to query a stack template. </p>
|
|
</div>
|
|
<div class="section" id="rts_03_0043__en-us_topic_0057973145_section307511"><h4 class="sectiontitle">URI</h4><p id="rts_03_0043__p76479013312">GET /v1/{project_id}/stacks/{stack_name}/{stack_id}/template</p>
|
|
<div class="note" id="rts_03_0043__note112466416546"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="rts_03_0043__rts_03_0025_p16370153133917">This API supports redirection. During the calling, you can specify only <strong id="rts_03_0043__rts_03_0025_b15118144423917">stack_name</strong> or <strong id="rts_03_0043__rts_03_0025_b1667664616393">stack_id</strong>.</p>
|
|
</div></div>
|
|
<p id="rts_03_0043__p3135115372419">For details about the parameters, see <a href="#rts_03_0043__table1759528275">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="rts_03_0043__table1759528275"></a><a name="table1759528275"></a><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0043__table1759528275" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rts_03_0043__row26011272716"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.5.2.5.1.1"><p id="rts_03_0043__p17762534144716"><strong id="rts_03_0043__b20668932105317">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_0043__p376433420478"><strong id="rts_03_0043__b36374335532">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_0043__p15766123474714"><strong id="rts_03_0043__b18459113410535">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_0043__p147683349474"><strong id="rts_03_0043__b33472353538">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0043__row10601725277"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.1 "><p id="rts_03_0043__p1765464961019">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.2 "><p id="rts_03_0043__p0655184916104">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.3 "><p id="rts_03_0043__p865694971017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.4 "><p id="rts_03_0043__p13658144921010">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0043__row161097438473"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.1 "><p id="rts_03_0043__p10658144911017">stack_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.2 "><p id="rts_03_0043__p1166014498107">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.3 "><p id="rts_03_0043__p666214493103">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.4 "><p id="rts_03_0043__p76631349181010">Specifies the stack name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0043__row131851844124918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.1 "><p id="rts_03_0043__p146651349161017">stack_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.2 "><p id="rts_03_0043__p1666614912100">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.3 "><p id="rts_03_0043__p106671249191011">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.5.2.5.1.4 "><p id="rts_03_0043__p6668124912103">Specifies the stack UUID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rts_03_0043__en-us_topic_0057973145_section2767599"><h4 class="sectiontitle">Request Parameter</h4><p id="rts_03_0043__p128056385720">N/A</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0043__en-us_topic_0057973145_section24908398"><h4 class="sectiontitle">Response Parameter</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0043__en-us_topic_0057973145_table22004215" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0043__en-us_topic_0057973145_row57369096"><th align="left" class="cellrowborder" valign="top" width="15.478452154784522%" id="mcps1.3.4.2.1.5.1.1"><p id="rts_03_0043__p13701251185014"><strong id="rts_03_0043__b143155317531">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.478452154784522%" id="mcps1.3.4.2.1.5.1.2"><p id="rts_03_0043__p13704145119507"><strong id="rts_03_0043__b1390295314534">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_0043__p3705151185017"><strong id="rts_03_0043__b1686465415532">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.374762523747634%" id="mcps1.3.4.2.1.5.1.4"><p id="rts_03_0043__p1371214511507"><strong id="rts_03_0043__b3761145515316">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0043__row19475211125716"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0043__p12920101455612">heat_template_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0043__p176411511191917">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0043__p692021420560">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.374762523747634%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0043__p12920714125613">Specifies the version of the HOT template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0043__en-us_topic_0057973145_row712884"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0043__en-us_topic_0057973145_p57743657">outputs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0043__p136411911141915">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0043__en-us_topic_0057973145_p46724626">Dict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.374762523747634%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0043__en-us_topic_0057973145_p6983522">Includes key-value pairs of the output data.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0043__en-us_topic_0057973145_row62851700"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0043__en-us_topic_0057973145_p57822944">parameters</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0043__p1641311161918">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0043__en-us_topic_0057973145_p53146884">Dict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.374762523747634%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0043__en-us_topic_0057973145_p66163095">Specifies the key-value pairs of template parameters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0043__row3334913144419"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0043__p7208173102111">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0043__p1064191116196">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0043__p17208531202115">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.374762523747634%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0043__p102088312216">Describes the stack template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0043__en-us_topic_0057973145_row58596944"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0043__en-us_topic_0057973145_p48732029">resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0043__p2641181113193">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.66833316668333%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0043__en-us_topic_0057973145_p54980295">Dict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.374762523747634%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0043__en-us_topic_0057973145_p15573968">Specifies the template resources.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rts_03_0043__en-us_topic_0057973145_section22848996"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="rts_03_0043__en-us_topic_0057973145_screen53531871">GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/template</pre>
|
|
</div>
|
|
<div class="section" id="rts_03_0043__en-us_topic_0057973145_section4314378"><h4 class="sectiontitle">Response Example</h4><pre class="screen" id="rts_03_0043__en-us_topic_0057973145_screen42971352112358">{
|
|
"description": "Hello world HOT template that just defines a single server. Contains just base features to verify base HOT support.\n",
|
|
"heat_template_version": "2013-05-23",
|
|
"outputs": {
|
|
"foo": {
|
|
"description": "Show foo parameter value",
|
|
"value": {
|
|
"get_param": "foo"
|
|
}
|
|
}
|
|
},
|
|
"parameters": {
|
|
"foo": {
|
|
"default": "secret",
|
|
"description": "Name of an existing key pair to use for the server",
|
|
"hidden": true,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"resources": {
|
|
"random_key_name": {
|
|
"properties": {
|
|
"length": 8
|
|
},
|
|
"type": "OS::Heat::RandomString"
|
|
}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rts_03_0043__en-us_topic_0057973145_section14779329217"><h4 class="sectiontitle">Return Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0043__table01411862119" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Normal return code</caption><thead align="left"><tr id="rts_03_0043__rts_03_0020_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_0043__rts_03_0020_en-us_topic_0057973117_p13413377194057"><strong id="rts_03_0043__rts_03_0020_b14910172512114">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_0043__rts_03_0020_en-us_topic_0057973117_p12741761194057"><strong id="rts_03_0043__rts_03_0020_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_0043__rts_03_0020_en-us_topic_0057973117_p25449701194057"><strong id="rts_03_0043__rts_03_0020_en-us_topic_0057973140_b842352706193020">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0043__rts_03_0020_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_0043__rts_03_0020_en-us_topic_0057973117_p8637307194057">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.2.2.4.1.2 "><p id="rts_03_0043__rts_03_0020_en-us_topic_0057973117_p28533244194057">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.2.2.4.1.3 "><p id="rts_03_0043__rts_03_0020_en-us_topic_0057973117_p29491459194057">Request was successful.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0043__table1927576173211" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Error return code</caption><thead align="left"><tr id="rts_03_0043__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_0043__rts_03_0025_p129561510144"><strong id="rts_03_0043__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_0043__rts_03_0025_p4959810444"><strong id="rts_03_0043__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_0043__rts_03_0025_p9959161020418"><strong id="rts_03_0043__rts_03_0025_b359171417">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0043__rts_03_0025_row179609103411"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0043__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_0043__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_0043__rts_03_0025_p9963110146">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0043__rts_03_0025_row181330274199"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0043__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_0043__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_0043__rts_03_0025_p11134162718196">Authorization failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0043__rts_03_0025_row16531631121913"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0043__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_0043__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_0043__rts_03_0025_en-us_topic_0057973122_p29751790194217">The requested resources are not found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0043__rts_03_0025_row196097477276"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0043__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_0043__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_0043__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_0042.html">Template Management</a></div>
|
|
</div>
|
|
</div>
|
|
|