yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
75624961765bc2e527c259dedc5cdbb01ca16700
doc-exports/docs/rfs/api-ref/UpdateStack.html
vladimirhasko 7562496176 testing rfs PR #1353
2025-07-24 16:58:05 +00:00

468 lines
35 KiB
HTML
Raw Blame History

<a name="UpdateStack"></a><a name="UpdateStack"></a>
<h1 class="topictitle1">Updating a Stack</h1>
<div id="body8662426"><div class="section" id="UpdateStack__section1851601573818"><h4 class="sectiontitle">Function</h4><p id="UpdateStack__p10516131519381">This API updates the attributes of a stack based on the information provided by users. One or more of the following attributes can be updated: <strong id="UpdateStack__b351781515387">description</strong>, <strong id="UpdateStack__b3517815153818">enable_deletion_protection</strong>, <strong id="UpdateStack__b1451761593819">enable_auto_rollback</strong>, and <strong id="UpdateStack__b1551761533818">agencies</strong>.</p>
<p id="UpdateStack__p1151721583813">This API updates only the fields contained in the information assigned by the user.</p>
<p id="UpdateStack__p551701512383">Note: All attributes are overwritten once updated. New parameters will overwrite original attributes of a stack.</p>
<p id="UpdateStack__p1951711510387">For example, if you want to add agencies, call GetStackMetadata to obtain the original agencies, integrate the information of old and new agencies, and then call UpdateStack.</p>
<ul id="UpdateStack__ul15518131515385"><li id="UpdateStack__li1651871511386">A stack cannot be updated if it is in a non-final state (ending with <em id="UpdateStack__i7518121593812">IN_PROGRESS</em>). The states may include:<ul id="UpdateStack__ul9518131513385"><li id="UpdateStack__li25181215153818">DEPLOYMENT_IN_PROGRESS</li><li id="UpdateStack__li6519111516387">DELETION_IN_PROGRESS</li><li id="UpdateStack__li18519815163818">ROLLBACK_IN_PROGRESS</li></ul>
</li><li id="UpdateStack__li10519415123818">If the value of enable_auto_rollback is changed from false to true, the stack state is determined more strictly. A stack cannot be updated if it is in a state ending with <em id="UpdateStack__i3520715153811">_FAILED</em>. The states may include:<ul id="UpdateStack__ul17520191515385"><li id="UpdateStack__li1452081543810">DEPLOYMENT_FAILED</li><li id="UpdateStack__li1252011154386">ROLLBACK_FAILED</li><li id="UpdateStack__li45201015163820">DELETION_FAILED</li></ul>
</li></ul>
</div>
<div class="section" id="UpdateStack__section115211115103818"><h4 class="sectiontitle">Debugging</h4><p id="UpdateStack__p152121513382">You can debug this API through automatic authentication in <a href="https://console.huaweicloud.com/apiexplorer/#/openapi/AOS/doc?api=UpdateStack" target="_blank" rel="noopener noreferrer">API Explorer</a> or use the SDK sample code generated by API Explorer.</p>
</div>
<div class="section" id="UpdateStack__section1152251573811"><h4 class="sectiontitle">URI</h4><p id="UpdateStack__p14522111520386">PATCH /v1/{project_id}/stacks/{stack_name}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateStack__table195231215193813" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdateStack__row14522171517382"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateStack__p1352341515387">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateStack__p16523111514383">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateStack__p1752471510389">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateStack__p852414159384">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateStack__row852212153382"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateStack__p12524715133818">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateStack__p15246156388">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateStack__p16525181573811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateStack__p5525415163811">A project ID is obtained by calling an API or from the console.</p>
<p id="UpdateStack__p17526415143817">Minimum: <strong id="UpdateStack__b1952641583813">3</strong></p>
<p id="UpdateStack__p1752631511382">Maximum: <strong id="UpdateStack__b13526915203818">64</strong></p>
</td>
</tr>
<tr id="UpdateStack__row1852215153387"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateStack__p4526161515385">stack_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateStack__p4527111503812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateStack__p12527151523811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateStack__p1352715150381">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="UpdateStack__p195288158388">Minimum: <strong id="UpdateStack__b152881503810">1</strong></p>
<p id="UpdateStack__p45281615163811">Maximum: <strong id="UpdateStack__b4528161583810">128</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateStack__section125281154380"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateStack__en-us_topic_0000001757038289_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="UpdateStack__row252941583819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="UpdateStack__p253081513815">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="UpdateStack__p953015152386">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="UpdateStack__p13530191518389">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="UpdateStack__p35312159385">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateStack__row12529715163810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateStack__p19531141503810">Client-Request-Id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateStack__p17531171573815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateStack__p253281563811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateStack__p6532111513389">A unique request ID is specified by a user to locate a request. UUID is recommended.</p>
<p id="UpdateStack__p753231516384">Minimum: <strong id="UpdateStack__b85321915183819">36</strong></p>
<p id="UpdateStack__p35331015113816">Maximum: <strong id="UpdateStack__b155331415193818">128</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateStack__en-us_topic_0000001757038289_request_UpdateStackRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="UpdateStack__row1353331511386"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="UpdateStack__p145341515203817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="UpdateStack__p3534101513383">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="UpdateStack__p6535215163811">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="UpdateStack__p753511159384">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateStack__row10533101512388"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateStack__p185359159387">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateStack__p1253561523819">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateStack__p95361215183811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateStack__p10536191512388">Description of a stack. It can be used by customers to identify their own stacks.</p>
<p id="UpdateStack__p553681512382">Minimum: <strong id="UpdateStack__b953601523813">0</strong></p>
<p id="UpdateStack__p20537191593810">Maximum: <strong id="UpdateStack__b1253771510387">1024</strong></p>
</td>
</tr>
<tr id="UpdateStack__row10533161523815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateStack__p205371515153819">stack_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateStack__p13537161523815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateStack__p2538101563815">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateStack__p5538121573811">Unique stack ID.</p>
<p id="UpdateStack__p55391715133817">It is a UUID generated by RFS when a stack is created.</p>
<p id="UpdateStack__p115391315123810">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="UpdateStack__p1054061533812">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="UpdateStack__p18540131519385">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="UpdateStack__p1454041543817">Minimum: <strong id="UpdateStack__b1541715143817">36</strong></p>
<p id="UpdateStack__p254141519387">Maximum: <strong id="UpdateStack__b17541915163810">36</strong></p>
</td>
</tr>
<tr id="UpdateStack__row15533161583812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateStack__p654211593818">enable_deletion_protection</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateStack__p19542121513818">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateStack__p0543141533812">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateStack__p18543161553812">Deletion protection flag. If this variable is not assigned, the default value is false, indicating that deletion protection is disabled by default. (After deletion protection is enabled, stacks cannot be deleted.)</p>
<p id="UpdateStack__p354481512385"><em id="UpdateStack__i145441715163812">In the UpdateStack API, if this variable is not assigned in the RequestBody, the deletion protection attribute of the stack will not be updated.</em></p>
</td>
</tr>
<tr id="UpdateStack__row0533915173820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateStack__p1654417156385">enable_auto_rollback</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateStack__p1154515152385">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateStack__p654541553819">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateStack__p1454612157385">Auto-rollback flag. If this variable is not assigned, the default value is false, indicating that auto-rollback is disabled by default. (After auto-rollback is enabled, if the deployment fails, the stack is automatically rolled back and returns to the previous stable status.)</p>
<p id="UpdateStack__p2546141543815"><em id="UpdateStack__i11546131513812">In the UpdateStack API, if this variable is not assigned in the RequestBody, the auto-rollback attribute of the stack will not be updated.</em> <em id="UpdateStack__i2546141511386">This property is mutually exclusive with the import resources using templates feature, which does not allow the deployment of templates containing imported resources if the stack's auto-rollback is set to true.</em></p>
</td>
</tr>
<tr id="UpdateStack__row175331815143810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="UpdateStack__p1454611503815">agencies</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="UpdateStack__p25468156388">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="UpdateStack__p254731520382">Array of <a href="#UpdateStack__en-us_topic_0000001757038289_request_Agency">Agency</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="UpdateStack__p15471015183819">Agency information.</p>
<p id="UpdateStack__p0547101518382">RFS uses an agency only in requests that involve resource operations, such as creating a stack (triggering deployment), creating an execution plan, deploying a stack, and deleting a stack. In addition, the agency applies only to resource operations performed by the provider bound to the agency. If the permissions provided by the agency are insufficient, operations on related resources may fail.</p>
<p id="UpdateStack__p205481315153812">Array Length: <strong id="UpdateStack__b854811553812">0 - 10</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdateStack__en-us_topic_0000001757038289_request_Agency"></a><a name="en-us_topic_0000001757038289_request_Agency"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdateStack__en-us_topic_0000001757038289_request_Agency" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Agency</caption><thead align="left"><tr id="UpdateStack__row1154861519387"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="UpdateStack__p13549141513385">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="UpdateStack__p175502150381">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="UpdateStack__p355091517384">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="UpdateStack__p1955014157387">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateStack__row195492015123815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="UpdateStack__p1755051510387">provider_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="UpdateStack__p85511515133817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="UpdateStack__p355131519384">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="UpdateStack__p8551111523810">Name of the provider used by a user. If the provider_name value given by the user is duplicate, 400 is returned.</p>
<p id="UpdateStack__p4552715143815">Minimum: <strong id="UpdateStack__b45521815133815">1</strong></p>
<p id="UpdateStack__p155527159380">Maximum: <strong id="UpdateStack__b1552141523816">128</strong></p>
</td>
</tr>
<tr id="UpdateStack__row185491615203815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="UpdateStack__p255271517386">agency_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="UpdateStack__p25535154380">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="UpdateStack__p18553101510384">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="UpdateStack__p1755381523818">IAM agency used by the corresponding provider. RFS uses this agency to access and create resources of the provider. Either agency_name or agency_urn must be specified.</p>
<p id="UpdateStack__p955419158385">Minimum: <strong id="UpdateStack__b7554191517387">1</strong></p>
<p id="UpdateStack__p055414150383">Maximum: <strong id="UpdateStack__b1055412156384">64</strong></p>
</td>
</tr>
<tr id="UpdateStack__row35491315103816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="UpdateStack__p10554715183816">agency_urn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="UpdateStack__p255511516387">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="UpdateStack__p1355581511389">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="UpdateStack__p10555151513816">Agency URN When a user defines an agency, either agency_name or agency_urn must be specified. You are advised to set agency_urn when using the trust agency. agency_name can only receive common agency names. If agency_name is set to a trust agency name, template deployment will fail.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateStack__section8556715103814"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateStack__p655613156385"><strong id="UpdateStack__b955616154389">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateStack__en-us_topic_0000001757038289_response_CommonErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="UpdateStack__row185563157384"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="UpdateStack__p165571415153811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="UpdateStack__p65571715153818">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="UpdateStack__p13558141553819">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateStack__row135560156383"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateStack__p145582154381">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateStack__p2558151593817">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateStack__p155596156389">Response code.</p>
</td>
</tr>
<tr id="UpdateStack__row14556151516389"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="UpdateStack__p15560715153819">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="UpdateStack__p105601015183814">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="UpdateStack__p1156061533817">Response message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateStack__p1561191510388"><strong id="UpdateStack__b16562615123813">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateStack__table205624154386" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="UpdateStack__row85621715113815"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.1"><p id="UpdateStack__p956361513819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.5.2.4.1.2"><p id="UpdateStack__p1656319158388">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.5.2.4.1.3"><p id="UpdateStack__p75631915173810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateStack__row956220152380"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpdateStack__p8564215153819">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpdateStack__p55641115153811">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpdateStack__p11564515113815">Response code.</p>
</td>
</tr>
<tr id="UpdateStack__row2562151523812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.1 "><p id="UpdateStack__p556518155384">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.5.2.4.1.2 "><p id="UpdateStack__p656512154380">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.5.2.4.1.3 "><p id="UpdateStack__p3565101513385">Response message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateStack__p16566615183819"><strong id="UpdateStack__b85671415173820">Status code: 403</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateStack__table556717158388" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="UpdateStack__row85676153381"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.1"><p id="UpdateStack__p15567201593813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.7.2.4.1.2"><p id="UpdateStack__p20568111583817">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.7.2.4.1.3"><p id="UpdateStack__p1756861503813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateStack__row10567181511386"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="UpdateStack__p8568715113814">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="UpdateStack__p15568315123813">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="UpdateStack__p14569815123819">Response code.</p>
</td>
</tr>
<tr id="UpdateStack__row856781593811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.1 "><p id="UpdateStack__p1657021517382">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.7.2.4.1.2 "><p id="UpdateStack__p05707154386">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.7.2.4.1.3 "><p id="UpdateStack__p12570315133815">Response message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateStack__p15711315103811"><strong id="UpdateStack__b957181515381">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateStack__table7571191511383" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="UpdateStack__row14572151511387"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.1"><p id="UpdateStack__p3572815153810">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.9.2.4.1.2"><p id="UpdateStack__p85723156380">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.9.2.4.1.3"><p id="UpdateStack__p457381512385">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateStack__row557221517389"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="UpdateStack__p7573181563819">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="UpdateStack__p157311573810">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="UpdateStack__p75731415163818">Response code.</p>
</td>
</tr>
<tr id="UpdateStack__row757231573811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.1 "><p id="UpdateStack__p45749154386">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.9.2.4.1.2 "><p id="UpdateStack__p145751515173812">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.9.2.4.1.3 "><p id="UpdateStack__p175751715143818">Response message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateStack__p257720154381"><strong id="UpdateStack__b557751513386">Status code: 409</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateStack__table1757771593813" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Response body parameters</caption><thead align="left"><tr id="UpdateStack__row5578161513381"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.1"><p id="UpdateStack__p155791515123815">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.11.2.4.1.2"><p id="UpdateStack__p257921513814">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.11.2.4.1.3"><p id="UpdateStack__p758019155383">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateStack__row85781815103820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="UpdateStack__p115801015163817">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="UpdateStack__p858061533812">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="UpdateStack__p1258031520382">Response code.</p>
</td>
</tr>
<tr id="UpdateStack__row15788156387"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.1 "><p id="UpdateStack__p158131518381">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.11.2.4.1.2 "><p id="UpdateStack__p10581151513384">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.11.2.4.1.3 "><p id="UpdateStack__p35821515143817">Response message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateStack__p175831115133811"><strong id="UpdateStack__b45831915103820">Status code: 429</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateStack__table8583315203816" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Response body parameters</caption><thead align="left"><tr id="UpdateStack__row558341573815"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.1"><p id="UpdateStack__p8694101511388">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.13.2.4.1.2"><p id="UpdateStack__p1569431533813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.13.2.4.1.3"><p id="UpdateStack__p2695171510383">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateStack__row458301583815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="UpdateStack__p7695315193812">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="UpdateStack__p11695181573814">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="UpdateStack__p106961215153811">Response code.</p>
</td>
</tr>
<tr id="UpdateStack__row658341573810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.1 "><p id="UpdateStack__p1569611157381">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.13.2.4.1.2 "><p id="UpdateStack__p869721523815">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.13.2.4.1.3 "><p id="UpdateStack__p56971157386">Response message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="UpdateStack__p2069818157380"><strong id="UpdateStack__b769841511389">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateStack__table14587131519383" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Response body parameters</caption><thead align="left"><tr id="UpdateStack__row13587915203813"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.1"><p id="UpdateStack__p36991315143819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.15.2.4.1.2"><p id="UpdateStack__p1069961543818">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.15.2.4.1.3"><p id="UpdateStack__p8699141512389">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateStack__row16587171573810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="UpdateStack__p26991315153816">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="UpdateStack__p570061510387">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="UpdateStack__p8700315123819">Response code.</p>
</td>
</tr>
<tr id="UpdateStack__row135871515103812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.1 "><p id="UpdateStack__p670031515382">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.15.2.4.1.2 "><p id="UpdateStack__p1670010153384">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.15.2.4.1.3 "><p id="UpdateStack__p1370013159387">Response message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateStack__section1701215163811"><h4 class="sectiontitle">Example Requests</h4><ul id="UpdateStack__ul7701141519383"><li id="UpdateStack__li167011215173815">Update the description of a stack.<pre class="screen" id="UpdateStack__screen11701715113816">PATCH https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack
{
"stack_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3",
"description" : "my hello world stack"
}</pre>
</li><li id="UpdateStack__li11702415193816">Disable deletion protection and auto-rollback of a stack.<pre class="screen" id="UpdateStack__screen2070216159386">PATCH https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack
{
"stack_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3",
"enable_deletion_protection" : false,
"enable_auto_rollback" : false
}</pre>
</li><li id="UpdateStack__li19703121573817">Update agency information of a stack.<pre class="screen" id="UpdateStack__screen1070351511382">PATCH https://{endpoint}/v1/ba2b9930c977f71edaeaa3a5e96a8ff1/stacks/my_hello_world_stack
{
"stack_id" : "1b15e005-bdbb-4bd7-8f9a-a09b6774b4b3",
"agencies" : [{
"provider_name" : "my_hello_world_provider",
"agency_name" : "my_agency"
}]
}</pre>
</li></ul>
</div>
<div class="section" id="UpdateStack__section4704111516384"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateStack__p117059155382">None</p>
</div>
<div class="section" id="UpdateStack__section1670551533820"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateStack__en-us_topic_0000001757038289_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateStack__row5596715143819"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="UpdateStack__p177059159380">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="UpdateStack__p167053159383">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateStack__row16596115113817"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateStack__p15705101514381">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateStack__p17052015133812">Updated.</p>
</td>
</tr>
<tr id="UpdateStack__row12596121533816"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateStack__p4705715123818">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateStack__p1370518153386">Invalid request.</p>
</td>
</tr>
<tr id="UpdateStack__row659619154384"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateStack__p9705615203812">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateStack__p170631503820">Authentication failed.</p>
</td>
</tr>
<tr id="UpdateStack__row105961515143815"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateStack__p070615155383">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><ol id="UpdateStack__ol470631553815"><li id="UpdateStack__li5706141513811">Invalid stack status.</li><li id="UpdateStack__li1706171543816">The user does not have the permission to call this API.</li></ol>
</td>
</tr>
<tr id="UpdateStack__row17596191517385"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateStack__p670610153381">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateStack__p15706111511384">The stack does not exist.</p>
</td>
</tr>
<tr id="UpdateStack__row5596141519384"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateStack__p13706115163813">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateStack__p2706101511383">Request conflict. Another request is being processed on the current stack.</p>
</td>
</tr>
<tr id="UpdateStack__row1259731523818"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateStack__p27071015113815">429</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateStack__p97076156389">Too frequent requests.</p>
</td>
</tr>
<tr id="UpdateStack__row959741503813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateStack__p1470719152389">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateStack__p187076150385">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>
View Git Blame Copy Permalink