1
0
forked from docs/doc-exports
doc-exports/docs/rts/api-ref/rts_03_0040.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

254 lines
19 KiB
HTML

<a name="rts_03_0040"></a><a name="rts_03_0040"></a>
<h1 class="topictitle1">Querying Events of a Stack Resource</h1>
<div id="body1511161465561"><div class="section" id="rts_03_0040__en-us_topic_0057973142_section9336199"><h4 class="sectiontitle">Function</h4><p id="rts_03_0040__en-us_topic_0057973142_p52169266">This API is used to query events of a stack resource.</p>
</div>
<div class="section" id="rts_03_0040__en-us_topic_0057973142_section16916929"><h4 class="sectiontitle">URI</h4><p id="rts_03_0040__p76479013312">GET /v1/{project_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/events</p>
<p id="rts_03_0040__p1981165717213">For details about the parameters, see <a href="#rts_03_0040__table1759528275">Table 1</a>.</p>
<div class="tablenoborder"><a name="rts_03_0040__table1759528275"></a><a name="table1759528275"></a><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0040__table1759528275" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rts_03_0040__row26011272716"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.1"><p id="rts_03_0040__p17762534144716"><strong id="rts_03_0040__b865719012339">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_0040__p376433420478"><strong id="rts_03_0040__b19433152203318">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_0040__p15766123474714"><strong id="rts_03_0040__b935919319335">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_0040__p147683349474"><strong id="rts_03_0040__b145520917335">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0040__row10601725277"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0040__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_0040__p0655184916104">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0040__p865694971017">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0040__p13658144921010">Specifies the project ID.</p>
</td>
</tr>
<tr id="rts_03_0040__row161097438473"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0040__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_0040__p1166014498107">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0040__p666214493103">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0040__p76631349181010">Specifies the stack name.</p>
</td>
</tr>
<tr id="rts_03_0040__row131851844124918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0040__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_0040__p1666614912100">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0040__p106671249191011">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0040__p6668124912103">Specifies the stack UUID.</p>
</td>
</tr>
<tr id="rts_03_0040__row04307962213"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0040__p12129567438">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rts_03_0040__p1146461564314">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0040__p184668153435">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0040__p8469181518439">Specifies the name of the resource in the stack.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rts_03_0040__en-us_topic_0057973142_section18034640"><h4 class="sectiontitle">Request Parameter</h4><p id="rts_03_0040__p17424125585412">N/A</p>
</div>
<div class="section" id="rts_03_0040__en-us_topic_0057973142_section28094036"><h4 class="sectiontitle">Response Parameter</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0040__en-us_topic_0057973142_table19596697" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0040__en-us_topic_0057973142_row50957800"><th align="left" class="cellrowborder" valign="top" width="16.27837216278372%" id="mcps1.3.4.2.1.5.1.1"><p id="rts_03_0040__p13701251185014"><strong id="rts_03_0040__b673734683310">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.11848815118488%" id="mcps1.3.4.2.1.5.1.2"><p id="rts_03_0040__p13704145119507"><strong id="rts_03_0040__b1066410498333">In</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.27837216278372%" id="mcps1.3.4.2.1.5.1.3"><p id="rts_03_0040__p3705151185017"><strong id="rts_03_0040__b19533135011339">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.32476752324767%" id="mcps1.3.4.2.1.5.1.4"><p id="rts_03_0040__p1371214511507"><strong id="rts_03_0040__b0812115316339">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0040__en-us_topic_0057973142_row48089434"><td class="cellrowborder" valign="top" width="16.27837216278372%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0040__en-us_topic_0057973142_p2930044">events</p>
</td>
<td class="cellrowborder" valign="top" width="15.11848815118488%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0040__p1713651475811">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.27837216278372%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0040__en-us_topic_0057973142_p36007027">List &lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.32476752324767%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0040__en-us_topic_0057973142_p18908415">Specifies the events of a resource.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="rts_03_0040__en-us_topic_0057973142_p35958012"><strong id="rts_03_0040__b1051010344">events</strong> structure information</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0040__en-us_topic_0057973142_table55186660" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0040__en-us_topic_0057973142_row11951831"><th align="left" class="cellrowborder" valign="top" width="16.471647164716472%" id="mcps1.3.4.4.1.5.1.1"><p id="rts_03_0040__p74171140185520"><strong id="rts_03_0040__b11649103416">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.291529152915292%" id="mcps1.3.4.4.1.5.1.2"><p id="rts_03_0040__p8420174014552"><strong id="rts_03_0040__b176074113411">In</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.471647164716472%" id="mcps1.3.4.4.1.5.1.3"><p id="rts_03_0040__p1423184015515"><strong id="rts_03_0040__b1443414743411">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.76517651765175%" id="mcps1.3.4.4.1.5.1.4"><p id="rts_03_0040__p104321240175517"><strong id="rts_03_0040__b1877018912347">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0040__en-us_topic_0057973142_row6835688"><td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0040__en-us_topic_0057973142_p16819822">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="15.291529152915292%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0040__p1282910278567">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0040__en-us_topic_0057973142_p20228341">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.76517651765175%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0040__en-us_topic_0057973142_p43923748">Specifies the resource name.</p>
</td>
</tr>
<tr id="rts_03_0040__en-us_topic_0057973142_row59769418"><td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0040__en-us_topic_0057973142_p9484678">event_time</p>
</td>
<td class="cellrowborder" valign="top" width="15.291529152915292%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0040__p16829112715569">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0040__en-us_topic_0057973142_p30061414">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.76517651765175%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0040__en-us_topic_0057973142_p67095859">Specifies the time when an event occurs.</p>
</td>
</tr>
<tr id="rts_03_0040__en-us_topic_0057973142_row66991827"><td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0040__en-us_topic_0057973142_p57628926">links</p>
</td>
<td class="cellrowborder" valign="top" width="15.291529152915292%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0040__p1582942715613">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0040__en-us_topic_0057973142_p37431442">List &lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="51.76517651765175%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0040__en-us_topic_0057973142_p36357906">Specifies the event URL list.</p>
</td>
</tr>
<tr id="rts_03_0040__en-us_topic_0057973142_row58785701"><td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0040__en-us_topic_0057973142_p64021321">logical_resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.291529152915292%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0040__p10829192719564">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0040__en-us_topic_0057973142_p18344506">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.76517651765175%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0040__en-us_topic_0057973142_p32111136">Specifies the logical resource ID.</p>
</td>
</tr>
<tr id="rts_03_0040__en-us_topic_0057973142_row20564775"><td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0040__en-us_topic_0057973142_p55134111">resource_status_reason</p>
</td>
<td class="cellrowborder" valign="top" width="15.291529152915292%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0040__p4829927175615">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0040__en-us_topic_0057973142_p36677991">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.76517651765175%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0040__en-us_topic_0057973142_p59022856">Specifies the resource operation reason.</p>
</td>
</tr>
<tr id="rts_03_0040__en-us_topic_0057973142_row61443660"><td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0040__en-us_topic_0057973142_p10880577">resource_status</p>
</td>
<td class="cellrowborder" valign="top" width="15.291529152915292%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0040__p13829192715563">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0040__en-us_topic_0057973142_p8911530">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.76517651765175%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0040__en-us_topic_0057973142_p16730874">Specifies the resource status.</p>
</td>
</tr>
<tr id="rts_03_0040__en-us_topic_0057973142_row16360140"><td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0040__en-us_topic_0057973142_p50102968">physical_resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.291529152915292%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0040__p148297276563">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0040__en-us_topic_0057973142_p31808604">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.76517651765175%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0040__en-us_topic_0057973142_p54798319">Specifies the physical resource ID.</p>
</td>
</tr>
<tr id="rts_03_0040__en-us_topic_0057973142_row23422824"><td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.1 "><p id="rts_03_0040__en-us_topic_0057973142_p18200597">id</p>
</td>
<td class="cellrowborder" valign="top" width="15.291529152915292%" headers="mcps1.3.4.4.1.5.1.2 "><p id="rts_03_0040__p982922719562">body</p>
</td>
<td class="cellrowborder" valign="top" width="16.471647164716472%" headers="mcps1.3.4.4.1.5.1.3 "><p id="rts_03_0040__en-us_topic_0057973142_p64962271">String</p>
</td>
<td class="cellrowborder" valign="top" width="51.76517651765175%" headers="mcps1.3.4.4.1.5.1.4 "><p id="rts_03_0040__en-us_topic_0057973142_p9067240">Specifies the event ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rts_03_0040__en-us_topic_0057973142_section51519734"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="rts_03_0040__en-us_topic_0057973142_screen63357815">GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/my_instance/events</pre>
</div>
<div class="section" id="rts_03_0040__en-us_topic_0057973142_section61024423"><h4 class="sectiontitle">Response Example</h4><pre class="screen" id="rts_03_0040__en-us_topic_0057973142_screen47550268112125">{
"events": [
{
"resource_name": "my_instance",
"event_time": "2014-01-26T17:21:35Z",
"links": [
{
"href": "http://x.x.x.x:8004/v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/my_instance/events/1304",
"rel": "self"
}
],
"logical_resource_id": "instacne_port",
"resource_status_reason": "state changed",
"resource_status": "CREATE_IN_PROGRESS",
"physical_resource_id": null,
"id": "1302"
}
]
}</pre>
</div>
<div class="section" id="rts_03_0040__en-us_topic_0057973142_section12348896"><h4 class="sectiontitle">Return Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0040__table01411862119" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Normal return code</caption><thead align="left"><tr id="rts_03_0040__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_0040__rts_03_0020_en-us_topic_0057973117_p13413377194057"><strong id="rts_03_0040__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_0040__rts_03_0020_en-us_topic_0057973117_p12741761194057"><strong id="rts_03_0040__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_0040__rts_03_0020_en-us_topic_0057973117_p25449701194057"><strong id="rts_03_0040__rts_03_0020_en-us_topic_0057973140_b842352706193020">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0040__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_0040__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_0040__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_0040__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_0040__table8571828153012" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Error return code</caption><thead align="left"><tr id="rts_03_0040__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_0040__rts_03_0029_p129561510144"><strong id="rts_03_0040__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_0040__rts_03_0029_p4959810444"><strong id="rts_03_0040__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_0040__rts_03_0029_p9959161020418"><strong id="rts_03_0040__rts_03_0029_en-us_topic_0057973140_b842352706193020">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0040__rts_03_0029_row179609103411"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0040__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_0040__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_0040__rts_03_0029_p9963110146">The server failed to process the request.</p>
</td>
</tr>
<tr id="rts_03_0040__rts_03_0029_row181330274199"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0040__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_0040__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_0040__rts_03_0029_p11134162718196">Authorization failed.</p>
</td>
</tr>
<tr id="rts_03_0040__rts_03_0029_row16531631121913"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0040__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_0040__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_0040__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_0037.html">Stack Event Management</a></div>
</div>
</div>