forked from docs/doc-exports
402 lines
31 KiB
HTML
402 lines
31 KiB
HTML
<a name="GetStackTemplate"></a><a name="GetStackTemplate"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining a Stack Template</h1>
|
|
<div id="body8662426"><div class="section" id="GetStackTemplate__section861105018448"><h4 class="sectiontitle">Function</h4><p id="GetStackTemplate__p662350184414">GetStackTemplate</p>
|
|
<p id="GetStackTemplate__p2621950154414">This API obtains the template used for the current deployment if the stack is in the final state.</p>
|
|
<p id="GetStackTemplate__p1562155019441">Note: When a stack is in a non-final state (ending with IN_PROGRESS), the stack is in the transition phase. This API obtains the template used for the last deployment of the stack. Only when the stack is in the final state (ending with COMPLETE or FAILED), this API obtains the template used for the current deployment. CREATION_COMPLETE is an exception because there is no template yet and 404 is returned, indicating that the template does not exist.</p>
|
|
<p id="GetStackTemplate__p116235014415">The non-final states may include:</p>
|
|
<ul id="GetStackTemplate__ul206225034410"><li id="GetStackTemplate__li762550144418">DEPLOYMENT_IN_PROGRESS</li><li id="GetStackTemplate__li46218506445">ROLLBACK_IN_PROGRESS</li><li id="GetStackTemplate__li8621050164411">DELETION_IN_PROGRESS</li></ul>
|
|
<p id="GetStackTemplate__p1562145015441">The final states may include:</p>
|
|
<ul id="GetStackTemplate__ul1621502448"><li id="GetStackTemplate__li15624506449">CREATION_COMPLETE (an empty stack has been created)</li><li id="GetStackTemplate__li862125013443">DEPLOYMENT_FAILED</li><li id="GetStackTemplate__li5621350174419">DEPLOYMENT_COMPLETE</li><li id="GetStackTemplate__li1362195014444">ROLLBACK_FAILED</li><li id="GetStackTemplate__li262850194413">ROLLBACK_COMPLETE</li><li id="GetStackTemplate__li106285010441">DELETION_FAILED</li></ul>
|
|
<p id="GetStackTemplate__p96275054417">If the template is successfully obtained, the template download link (OBS presigned URL, valid for 5 minutes) is returned in temporary redirection mode. Most clients automatically redirect and download the template. If automatic redirection is not performed, refer to the HTTP redirection rule and manually download the template.</p>
|
|
</div>
|
|
<div class="section" id="GetStackTemplate__section6632050154417"><h4 class="sectiontitle">URI</h4><p id="GetStackTemplate__p4631950114418">GET /v1/{project_id}/stacks/{stack_name}/templates</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackTemplate__table18631550184418" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="GetStackTemplate__row1863135020445"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="GetStackTemplate__p2063175019446">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="GetStackTemplate__p16636509440">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="GetStackTemplate__p46475015441">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="GetStackTemplate__p136485013440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="GetStackTemplate__row7631550154419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="GetStackTemplate__p11641950104411">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="GetStackTemplate__p15641850154412">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="GetStackTemplate__p2645505444">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="GetStackTemplate__p16455010443">A project ID is obtained by calling an API or from the console.</p>
|
|
<p id="GetStackTemplate__p16475064415">Minimum: <strong id="GetStackTemplate__b66414508444">3</strong></p>
|
|
<p id="GetStackTemplate__p1564950154415">Maximum: <strong id="GetStackTemplate__b0645508445">64</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row163205034412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="GetStackTemplate__p2064105024417">stack_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="GetStackTemplate__p166475034418">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="GetStackTemplate__p76485013441">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="GetStackTemplate__p1364150154414">A stack name is unique within its domain (domain_id), region, and project (project_id). It is case-sensitive and starts with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
|
|
<p id="GetStackTemplate__p186435015446">Minimum: <strong id="GetStackTemplate__b186415501447">1</strong></p>
|
|
<p id="GetStackTemplate__p126411504449">Maximum: <strong id="GetStackTemplate__b5647504443">128</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackTemplate__table36565074412" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="GetStackTemplate__row76555015443"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="GetStackTemplate__p1765145013444">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="GetStackTemplate__p165550114413">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="GetStackTemplate__p146555064413">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="GetStackTemplate__p1365150164412">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="GetStackTemplate__row06585013447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="GetStackTemplate__p5651450194411">stack_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="GetStackTemplate__p56511509445">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="GetStackTemplate__p116565016441">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="GetStackTemplate__p16525044414">Unique stack ID.</p>
|
|
<p id="GetStackTemplate__p166514507448">It is a UUID generated by RFS when a stack is created.</p>
|
|
<p id="GetStackTemplate__p16651506449">Stack names are unique at one specific time, so you can create a stack named HelloWorld and another stack with the same name after deleting the first one.</p>
|
|
<p id="GetStackTemplate__p36514509440">For parallel development, team members may want to ensure that they are operating the stack they created, not one with the same name created by other members after deleting the previous one.</p>
|
|
<p id="GetStackTemplate__p166515015449">To avoid this mismatch, check the ID, since RFS ensures each stack has a unique ID that does not change with updates. If the stack_id value differs from the current stack ID, 400 is returned.</p>
|
|
<p id="GetStackTemplate__p17662050204415">Minimum: <strong id="GetStackTemplate__b366350174413">36</strong></p>
|
|
<p id="GetStackTemplate__p16665015441">Maximum: <strong id="GetStackTemplate__b466650154419">36</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="GetStackTemplate__section466155024410"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackTemplate__en-us_topic_0000001757158473_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="GetStackTemplate__row116613509443"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="GetStackTemplate__p66665019446">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="GetStackTemplate__p116645013442">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="GetStackTemplate__p156675084412">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="GetStackTemplate__p136695064415">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="GetStackTemplate__row2668506443"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="GetStackTemplate__p1066450204417">Client-Request-Id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="GetStackTemplate__p96735054417">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="GetStackTemplate__p156795074417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="GetStackTemplate__p126785013444">A unique request ID is specified by a user to locate a request. UUID is recommended.</p>
|
|
<p id="GetStackTemplate__p106745084410">Minimum: <strong id="GetStackTemplate__b1167165024411">36</strong></p>
|
|
<p id="GetStackTemplate__p367450154419">Maximum: <strong id="GetStackTemplate__b867145010443">128</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="GetStackTemplate__section116715064413"><h4 class="sectiontitle">Response Parameters</h4><p id="GetStackTemplate__p136775015444"><strong id="GetStackTemplate__b367145012440">Status code: 307</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackTemplate__en-us_topic_0000001757158473_ResponseHeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response header parameters</caption><thead align="left"><tr id="GetStackTemplate__row067105064410"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.3.2.4.1.1"><p id="GetStackTemplate__p96715016441">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="GetStackTemplate__p116718502441">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="GetStackTemplate__p868205018446">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="GetStackTemplate__row146775010446"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.3.2.4.1.1 "><p id="GetStackTemplate__p9681750194411">Location</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="GetStackTemplate__p14681050204414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="GetStackTemplate__p26814500445">HTTP redirect header. The client can use this header to redirect to a template download link (OBS presigned URL, valid for 5 minutes).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="GetStackTemplate__p156835019446"><strong id="GetStackTemplate__b2681850124420">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackTemplate__en-us_topic_0000001757158473_response_CommonErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="GetStackTemplate__row10681050164410"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="GetStackTemplate__p7681950174418">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="GetStackTemplate__p7681850114414">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="GetStackTemplate__p146815014440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="GetStackTemplate__row156835074411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="GetStackTemplate__p1168165024410">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="GetStackTemplate__p156814505443">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="GetStackTemplate__p269145054412">Response code.</p>
|
|
<p id="GetStackTemplate__p10691650174415">Minimum: <strong id="GetStackTemplate__b36975054412">11</strong></p>
|
|
<p id="GetStackTemplate__p469165074417">Maximum: <strong id="GetStackTemplate__b2691850164411">11</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row1768050154414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="GetStackTemplate__p13691450104416">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="GetStackTemplate__p569150134417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="GetStackTemplate__p36975044415">Response message.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row168135013442"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="GetStackTemplate__p569145018444">encoded_authorization_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="GetStackTemplate__p1069850184410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="GetStackTemplate__p969550104417">The message contains information about unauthorized requests.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="GetStackTemplate__p1369195019441"><strong id="GetStackTemplate__b156955024413">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackTemplate__table96965034413" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="GetStackTemplate__row176985014410"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="GetStackTemplate__p1670450184411">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="GetStackTemplate__p570135012442">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="GetStackTemplate__p1770135015440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="GetStackTemplate__row86915014418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="GetStackTemplate__p12705503449">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="GetStackTemplate__p1170105016446">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="GetStackTemplate__p1870750134414">Response code.</p>
|
|
<p id="GetStackTemplate__p2070145054418">Minimum: <strong id="GetStackTemplate__b17095074414">11</strong></p>
|
|
<p id="GetStackTemplate__p97011507442">Maximum: <strong id="GetStackTemplate__b6702050154415">11</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row176911501444"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="GetStackTemplate__p4701550114419">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="GetStackTemplate__p147015094413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="GetStackTemplate__p1570950104418">Response message.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row2695509442"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="GetStackTemplate__p1470175015442">encoded_authorization_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="GetStackTemplate__p147012508441">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="GetStackTemplate__p27115012444">The message contains information about unauthorized requests.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="GetStackTemplate__p97125014414"><strong id="GetStackTemplate__b1571125074415">Status code: 403</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackTemplate__table127175014448" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="GetStackTemplate__row137155044419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="GetStackTemplate__p1571250184416">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="GetStackTemplate__p1171550174411">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="GetStackTemplate__p177117504448">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="GetStackTemplate__row9711650154413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="GetStackTemplate__p187175084415">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="GetStackTemplate__p1172350144415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="GetStackTemplate__p20728505448">Response code.</p>
|
|
<p id="GetStackTemplate__p117235018443">Minimum: <strong id="GetStackTemplate__b37215500442">11</strong></p>
|
|
<p id="GetStackTemplate__p19721950184410">Maximum: <strong id="GetStackTemplate__b17215018445">11</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row87195094413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="GetStackTemplate__p872850164414">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="GetStackTemplate__p147235013448">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="GetStackTemplate__p1372175074411">Response message.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row207119508445"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="GetStackTemplate__p1572150184418">encoded_authorization_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="GetStackTemplate__p177245016447">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="GetStackTemplate__p372850114413">The message contains information about unauthorized requests.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="GetStackTemplate__p97295010444"><strong id="GetStackTemplate__b072105015449">Status code: 404</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackTemplate__table14721750144416" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="GetStackTemplate__row1072135054411"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="GetStackTemplate__p873135024420">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="GetStackTemplate__p1073350194413">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="GetStackTemplate__p5748506448">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="GetStackTemplate__row27319508445"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="GetStackTemplate__p177416503448">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="GetStackTemplate__p8741750164419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="GetStackTemplate__p2074350124418">Response code.</p>
|
|
<p id="GetStackTemplate__p1174350104413">Minimum: <strong id="GetStackTemplate__b1674175074411">11</strong></p>
|
|
<p id="GetStackTemplate__p6741350134415">Maximum: <strong id="GetStackTemplate__b107435017447">11</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row47315018445"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="GetStackTemplate__p074125094413">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="GetStackTemplate__p8741750194416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="GetStackTemplate__p4741850124410">Response message.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row117314503449"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="GetStackTemplate__p1474115013443">encoded_authorization_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="GetStackTemplate__p117417502446">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="GetStackTemplate__p274155011446">The message contains information about unauthorized requests.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="GetStackTemplate__p274195015445"><strong id="GetStackTemplate__b875250154417">Status code: 429</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackTemplate__table97575044419" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="GetStackTemplate__row5751650164416"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="GetStackTemplate__p19751506442">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="GetStackTemplate__p1075195004417">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="GetStackTemplate__p117515014414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="GetStackTemplate__row07575015446"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="GetStackTemplate__p11751250124416">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="GetStackTemplate__p1175155054414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="GetStackTemplate__p197575012442">Response code.</p>
|
|
<p id="GetStackTemplate__p197615019441">Minimum: <strong id="GetStackTemplate__b1076155016440">11</strong></p>
|
|
<p id="GetStackTemplate__p16761506447">Maximum: <strong id="GetStackTemplate__b12761750184419">11</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row3754504440"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="GetStackTemplate__p176175094417">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="GetStackTemplate__p16761050124411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="GetStackTemplate__p1176175034415">Response message.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row57535020443"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="GetStackTemplate__p1276155054413">encoded_authorization_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="GetStackTemplate__p17761750204417">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="GetStackTemplate__p147685016445">The message contains information about unauthorized requests.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="GetStackTemplate__p127615016442"><strong id="GetStackTemplate__b19761950184415">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackTemplate__table1476105014441" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="GetStackTemplate__row67675014447"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.1"><p id="GetStackTemplate__p277165024413">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.15.2.4.1.2"><p id="GetStackTemplate__p47775013443">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.15.2.4.1.3"><p id="GetStackTemplate__p1771250144413">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="GetStackTemplate__row1076125010447"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="GetStackTemplate__p187710503447">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="GetStackTemplate__p7771050204413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="GetStackTemplate__p28465018444">Response code.</p>
|
|
<p id="GetStackTemplate__p68425064416">Minimum: <strong id="GetStackTemplate__b9855508447">11</strong></p>
|
|
<p id="GetStackTemplate__p685185054417">Maximum: <strong id="GetStackTemplate__b88575034416">11</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row276550184419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="GetStackTemplate__p118535054415">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="GetStackTemplate__p48575084414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="GetStackTemplate__p185250194417">Response message.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row176350164411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.1 "><p id="GetStackTemplate__p585195015448">encoded_authorization_message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.15.2.4.1.2 "><p id="GetStackTemplate__p19851502443">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.15.2.4.1.3 "><p id="GetStackTemplate__p128535034412">The message contains information about unauthorized requests.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="GetStackTemplate__section13851850114412"><h4 class="sectiontitle">Example Requests</h4><ul id="GetStackTemplate__ul2857502447"><li id="GetStackTemplate__li58575014441">Obtain a stack template.<pre class="screen" id="GetStackTemplate__screen1185150154414">GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/templates</pre>
|
|
</li><li id="GetStackTemplate__li1885105024416">Obtain a stack template and check whether the stack ID matches the current stack.<pre class="screen" id="GetStackTemplate__screen1386125024416">GET https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack/templates?stack_id=ea6a4f0e-ee8a-494e-b12a-8be4a1e65af2</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="GetStackTemplate__section486850114417"><h4 class="sectiontitle">Example Responses</h4><p id="GetStackTemplate__p486125064410">None</p>
|
|
</div>
|
|
<div class="section" id="GetStackTemplate__section9861150184414"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="GetStackTemplate__en-us_topic_0000001757158473_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="GetStackTemplate__row13861250154412"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="GetStackTemplate__p58725011445">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="GetStackTemplate__p388165020447">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="GetStackTemplate__row5861750204417"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackTemplate__p12884505442">307</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackTemplate__p1388250144420">Stack template obtained. Temporary redirect.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row18675044418"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackTemplate__p128820508447">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackTemplate__p1388750144415">Invalid request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row38675019446"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackTemplate__p588185074413">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackTemplate__p4881650104419">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row1887175014418"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackTemplate__p208885018441">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackTemplate__p138525017445">The user does not have the permission to call this API.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row487050194412"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackTemplate__p19385125013442">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackTemplate__p33863502443">The stack or template does not exist.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row887750174411"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackTemplate__p1138685017449">429</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackTemplate__p1438675010449">Too frequent requests.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="GetStackTemplate__row1387175016449"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="GetStackTemplate__p1138695034418">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="GetStackTemplate__p10386850104411">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">Stacks</a></div>
|
|
</div>
|
|
</div>
|
|
|