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>
168 lines
13 KiB
HTML
168 lines
13 KiB
HTML
<a name="rts_03_0033"></a><a name="rts_03_0033"></a>
|
|
|
|
<h1 class="topictitle1">Marking a Resource as Unhealthy</h1>
|
|
<div id="body1511161465561"><div class="section" id="rts_03_0033__en-us_topic_0057973134_section48907899"><h4 class="sectiontitle">Function</h4><p id="rts_03_0033__en-us_topic_0057973134_p47024962">This API is used to mark the status of a specified resource as unhealthy.</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0033__en-us_topic_0057973134_section37517908"><h4 class="sectiontitle">URI</h4><p id="rts_03_0033__p76479013312">PATCH /v1/{project_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name_or_physical_id}</p>
|
|
<p id="rts_03_0033__p18606843121015">For details about the parameters, see <a href="#rts_03_0033__table1759528275">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="rts_03_0033__table1759528275"></a><a name="table1759528275"></a><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0033__table1759528275" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rts_03_0033__row26011272716"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.1"><p id="rts_03_0033__p17762534144716"><strong id="rts_03_0033__b17631786153">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_0033__p376433420478"><strong id="rts_03_0033__b10803151081511">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_0033__p15766123474714"><strong id="rts_03_0033__b731419128158">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_0033__p147683349474"><strong id="rts_03_0033__b04924137151">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0033__row10601725277"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0033__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_0033__p0655184916104">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0033__p865694971017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0033__p13658144921010">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0033__row161097438473"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0033__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_0033__p1166014498107">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0033__p666214493103">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0033__p76631349181010">Specifies the stack name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0033__row131851844124918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0033__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_0033__p1666614912100">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0033__p106671249191011">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0033__p6668124912103">Specifies the stack UUID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0033__row84164613820"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0033__p12129567438">resource_name_or_physical_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rts_03_0033__p542494644613">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0033__p15426146174611">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0033__p34271146144611">Specifies the resource name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rts_03_0033__en-us_topic_0057973134_section2116855"><h4 class="sectiontitle">Request Parameter</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0033__en-us_topic_0057973134_table50838716111443" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0033__en-us_topic_0057973134_row2537880111443"><th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.6.1.1"><p id="rts_03_0033__p13701251185014"><strong id="rts_03_0033__b2531842181518">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.6.1.2"><p id="rts_03_0033__p13704145119507"><strong id="rts_03_0033__b1161444101513">In</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.6.1.3"><p id="rts_03_0033__p3705151185017"><strong id="rts_03_0033__b9277045121517">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.6.1.4"><p id="rts_03_0033__p18709155145010"><strong id="rts_03_0033__b4308946161515">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44%" id="mcps1.3.3.2.1.6.1.5"><p id="rts_03_0033__p1371214511507"><strong id="rts_03_0033__b142341055131515">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0033__en-us_topic_0057973134_row5444736111443"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.1 "><p id="rts_03_0033__en-us_topic_0057973134_p7891384111451">mark_unhealthy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.2 "><p id="rts_03_0033__p585932933920">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.3 "><p id="rts_03_0033__en-us_topic_0057973134_p35222334111451">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.4 "><p id="rts_03_0033__en-us_topic_0057973134_p34436805111451">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.3.2.1.6.1.5 "><p id="rts_03_0033__en-us_topic_0057973134_p37917812111451">Specifies whether to mark the status of a resource as unhealthy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0033__en-us_topic_0057973134_row11268194111443"><td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.1 "><p id="rts_03_0033__en-us_topic_0057973134_p60342426111451">resource_status_reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.2 "><p id="rts_03_0033__p1485972973912">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.3 "><p id="rts_03_0033__en-us_topic_0057973134_p55898326111451">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.6.1.4 "><p id="rts_03_0033__en-us_topic_0057973134_p31470518111451">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.3.2.1.6.1.5 "><p id="rts_03_0033__en-us_topic_0057973134_p66084002111451">Describes the cause causing the current resource status.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rts_03_0033__en-us_topic_0057973134_section19051702"><h4 class="sectiontitle">Response Parameter</h4><p id="rts_03_0033__en-us_topic_0057973134_p21554506">This operation does not return the response body.</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0033__en-us_topic_0057973134_section37247592"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="rts_03_0033__en-us_topic_0057973134_screen25903308115846">PATCH /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/65eb0ae7-36de-4104-aace-6bd040a2f95f/resources/my_instance
|
|
{
|
|
"mark_unhealthy": false,
|
|
"resource_status_reason": "test reset"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rts_03_0033__en-us_topic_0057973134_section66792880"><h4 class="sectiontitle">Response Example</h4><p id="rts_03_0033__en-us_topic_0057973134_p20740403">None</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0033__en-us_topic_0057973134_section64265014"><h4 class="sectiontitle">Return Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0033__table01411862119" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Normal return code</caption><thead align="left"><tr id="rts_03_0033__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_0033__rts_03_0020_en-us_topic_0057973117_p13413377194057"><strong id="rts_03_0033__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_0033__rts_03_0020_en-us_topic_0057973117_p12741761194057"><strong id="rts_03_0033__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_0033__rts_03_0020_en-us_topic_0057973117_p25449701194057"><strong id="rts_03_0033__rts_03_0020_en-us_topic_0057973140_b842352706193020">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0033__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_0033__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_0033__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_0033__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_0033__table1389832182115" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Error return code</caption><thead align="left"><tr id="rts_03_0033__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_0033__rts_03_0029_p129561510144"><strong id="rts_03_0033__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_0033__rts_03_0029_p4959810444"><strong id="rts_03_0033__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_0033__rts_03_0029_p9959161020418"><strong id="rts_03_0033__rts_03_0029_en-us_topic_0057973140_b842352706193020">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0033__rts_03_0029_row179609103411"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0033__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_0033__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_0033__rts_03_0029_p9963110146">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0033__rts_03_0029_row181330274199"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0033__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_0033__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_0033__rts_03_0029_p11134162718196">Authorization failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0033__rts_03_0029_row16531631121913"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0033__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_0033__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_0033__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_0028.html">Stack Resource Management</a></div>
|
|
</div>
|
|
</div>
|
|
|