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

147 lines
11 KiB
HTML

<a name="rts_03_0035"></a><a name="rts_03_0035"></a>
<h1 class="topictitle1">Canceling Stack Updates</h1>
<div id="body1511161465561"><div class="section" id="rts_03_0035__en-us_topic_0057973136_section43525296"><h4 class="sectiontitle">Function</h4><p id="rts_03_0035__en-us_topic_0057973136_p11837229">This API is used to cancel updating a stack.</p>
</div>
<div class="section" id="rts_03_0035__en-us_topic_0057973136_section56183344"><h4 class="sectiontitle">URI</h4><p id="rts_03_0035__p76479013312">POST /v1/{project_id}/stacks/{stack_name}/{stack_id}/actions</p>
<p id="rts_03_0035__p1132717369113">For details about the parameters, see <a href="#rts_03_0035__table1759528275">Table 1</a>.</p>
<div class="tablenoborder"><a name="rts_03_0035__table1759528275"></a><a name="table1759528275"></a><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0035__table1759528275" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rts_03_0035__row26011272716"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.1"><p id="rts_03_0035__p17762534144716"><strong id="rts_03_0035__b176423309199">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_0035__p376433420478"><strong id="rts_03_0035__b9404171852020">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_0035__p15766123474714"><strong id="rts_03_0035__b153912072017">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_0035__p147683349474"><strong id="rts_03_0035__b1640112412209">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0035__row10601725277"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0035__p1765464961019">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rts_03_0035__p0655184916104">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0035__p865694971017">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0035__p13658144921010">Specifies the project ID.</p>
</td>
</tr>
<tr id="rts_03_0035__row161097438473"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0035__p10658144911017">stack_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rts_03_0035__p1166014498107">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0035__p666214493103">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0035__p76631349181010">Specifies the stack name.</p>
</td>
</tr>
<tr id="rts_03_0035__row131851844124918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0035__p146651349161017">stack_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rts_03_0035__p1666614912100">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0035__p106671249191011">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0035__p6668124912103">Specifies the stack UUID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rts_03_0035__en-us_topic_0057973136_section35888053"><h4 class="sectiontitle">Request Parameter</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0035__en-us_topic_0057973136_table64261042111621" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0035__en-us_topic_0057973136_row45291048111621"><th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.3.2.1.6.1.1"><p id="rts_03_0035__p13701251185014"><strong id="rts_03_0035__b172311439192016">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.861386138613863%" id="mcps1.3.3.2.1.6.1.2"><p id="rts_03_0035__p13704145119507"><strong id="rts_03_0035__b14446184117209">In</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.3.2.1.6.1.3"><p id="rts_03_0035__p3705151185017"><strong id="rts_03_0035__b105881242202014">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.3.2.1.6.1.4"><p id="rts_03_0035__p18709155145010"><strong id="rts_03_0035__b1550164315208">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.57425742574257%" id="mcps1.3.3.2.1.6.1.5"><p id="rts_03_0035__p1371214511507"><strong id="rts_03_0035__b428918479200">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0035__en-us_topic_0057973136_row15561460111621"><td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.1.6.1.1 "><p id="rts_03_0035__en-us_topic_0057973136_p52740565111627">cancel_update</p>
</td>
<td class="cellrowborder" valign="top" width="13.861386138613863%" headers="mcps1.3.3.2.1.6.1.2 "><p id="rts_03_0035__p42427320425">body</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.1.6.1.3 "><p id="rts_03_0035__en-us_topic_0057973136_p44127350111627">Object</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.3.2.1.6.1.4 "><p id="rts_03_0035__en-us_topic_0057973136_p17545629111627">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="42.57425742574257%" headers="mcps1.3.3.2.1.6.1.5 "><p id="rts_03_0035__en-us_topic_0057973136_p11909807111627">Cancels updating a stack.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rts_03_0035__en-us_topic_0057973136_section54557022"><h4 class="sectiontitle">Response Parameter</h4><p id="rts_03_0035__en-us_topic_0057973136_p61647276">This operation does not return the response body.</p>
</div>
<div class="section" id="rts_03_0035__en-us_topic_0057973136_section21251158"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="rts_03_0035__en-us_topic_0057973136_screen3669825911178">POST /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/actions
{
"cancel_update": null
}</pre>
</div>
<div class="section" id="rts_03_0035__en-us_topic_0057973136_section57042701"><h4 class="sectiontitle">Response Example</h4><p id="rts_03_0035__en-us_topic_0057973136_p58040562">None</p>
</div>
<div class="section" id="rts_03_0035__en-us_topic_0057973136_section43622269"><h4 class="sectiontitle">Return Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0035__table01411862119" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Normal return code</caption><thead align="left"><tr id="rts_03_0035__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_0035__rts_03_0020_en-us_topic_0057973117_p13413377194057"><strong id="rts_03_0035__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_0035__rts_03_0020_en-us_topic_0057973117_p12741761194057"><strong id="rts_03_0035__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_0035__rts_03_0020_en-us_topic_0057973117_p25449701194057"><strong id="rts_03_0035__rts_03_0020_en-us_topic_0057973140_b842352706193020">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0035__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_0035__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_0035__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_0035__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_0035__table1389832182115" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Error return code</caption><thead align="left"><tr id="rts_03_0035__rts_03_0029_row16955110342"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.7.3.2.4.1.1"><p id="rts_03_0035__rts_03_0029_p129561510144"><strong id="rts_03_0035__rts_03_0029_b1235759101013">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_0035__rts_03_0029_p4959810444"><strong id="rts_03_0035__rts_03_0029_en-us_topic_0057973140_b84235270615814_1">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_0035__rts_03_0029_p9959161020418"><strong id="rts_03_0035__rts_03_0029_en-us_topic_0057973140_b842352706193020">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0035__rts_03_0029_row179609103411"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0035__rts_03_0029_p896118101840">400</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0035__rts_03_0029_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_0035__rts_03_0029_p9963110146">The server failed to process the request.</p>
</td>
</tr>
<tr id="rts_03_0035__rts_03_0029_row181330274199"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0035__rts_03_0029_p18134027201912">401</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0035__rts_03_0029_p1713419274191">Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0035__rts_03_0029_p11134162718196">Authorization failed.</p>
</td>
</tr>
<tr id="rts_03_0035__rts_03_0029_row16531631121913"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0035__rts_03_0029_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_0035__rts_03_0029_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_0035__rts_03_0029_en-us_topic_0057973122_p29751790194217">The requested resources are not found.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rts_03_0034.html">Stack Action Management</a></div>
</div>
</div>