forked from laiweijian4/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>
153 lines
12 KiB
HTML
153 lines
12 KiB
HTML
<a name="rts_03_0031"></a><a name="rts_03_0031"></a>
|
|
|
|
<h1 class="topictitle1">Querying Metadata of a Stack Resource</h1>
|
|
<div id="body1511161465560"><div class="section" id="rts_03_0031__en-us_topic_0057973132_section48978414"><h4 class="sectiontitle">Function</h4><p id="rts_03_0031__en-us_topic_0057973132_p18197854">This API is used to query metadata of a stack resource.</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0031__en-us_topic_0057973132_section38152543"><h4 class="sectiontitle">URI</h4><p id="rts_03_0031__p76479013312">GET /v1/{project_id}/stacks/{stack_name}/{stack_id}/resources/{resource_name}/metadata</p>
|
|
<p id="rts_03_0031__p047012261291">For details about the parameters, see <a href="#rts_03_0031__table1759528275">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="rts_03_0031__table1759528275"></a><a name="table1759528275"></a><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0031__table1759528275" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rts_03_0031__row26011272716"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.1"><p id="rts_03_0031__p17762534144716"><strong id="rts_03_0031__b88211946102814">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_0031__p376433420478"><strong id="rts_03_0031__b116471348132813">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_0031__p15766123474714"><strong id="rts_03_0031__b361412499288">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_0031__p147683349474"><strong id="rts_03_0031__b10686105018283">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0031__row10601725277"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0031__p11761545397">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rts_03_0031__p87714510915">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0031__p1179184514911">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0031__p281345897">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0031__row161097438473"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0031__p8822045897">stack_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rts_03_0031__p16849457918">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0031__p19845458917">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0031__p12861445998">Specifies the stack name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0031__row131851844124918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0031__p1888345494">stack_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rts_03_0031__p20891145797">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0031__p1090345597">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0031__p169210457919">Specifies the stack UUID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0031__row84164613820"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0031__p694145392">resource_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.2 "><p id="rts_03_0031__p189516459920">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0031__p149684518916">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0031__p149711450910">Specifies the name of the resource in the stack.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rts_03_0031__en-us_topic_0057973132_section7828572"><h4 class="sectiontitle">Request Parameter</h4><p id="rts_03_0031__p056714175444">N/A</p>
|
|
</div>
|
|
<div class="section" id="rts_03_0031__en-us_topic_0057973132_section3348284"><h4 class="sectiontitle">Response Parameter</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0031__en-us_topic_0057973132_table19168884" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0031__en-us_topic_0057973132_row52134235"><th align="left" class="cellrowborder" valign="top" width="16.09160916091609%" id="mcps1.3.4.2.1.5.1.1"><p id="rts_03_0031__p13701251185014"><strong id="rts_03_0031__b1314463762910">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.09160916091609%" id="mcps1.3.4.2.1.5.1.2"><p id="rts_03_0031__p13704145119507"><strong id="rts_03_0031__b115951938102910">In</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.241724172417243%" id="mcps1.3.4.2.1.5.1.3"><p id="rts_03_0031__p3705151185017"><strong id="rts_03_0031__b10738153962920">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.57505750575058%" id="mcps1.3.4.2.1.5.1.4"><p id="rts_03_0031__p1371214511507"><strong id="rts_03_0031__b1056104016299">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0031__en-us_topic_0057973132_row10618981"><td class="cellrowborder" valign="top" width="16.09160916091609%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0031__en-us_topic_0057973132_p54831104">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.09160916091609%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0031__p1712310173417">body</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.241724172417243%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0031__en-us_topic_0057973132_p12134444">Dict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.57505750575058%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0031__en-us_topic_0057973132_p22977365">Specifies the resource metadata.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rts_03_0031__en-us_topic_0057973132_section30134562"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="rts_03_0031__en-us_topic_0057973132_screen49227299">GET /v1/95d02433133a4c0a87ba6967474a2ad3/stacks/HeatStack/c89c4bb3-96cb-4a55-aafa-076a7939a306/resources/my_instance/metadata</pre>
|
|
</div>
|
|
<div class="section" id="rts_03_0031__en-us_topic_0057973132_section2775606"><h4 class="sectiontitle">Response Example</h4><pre class="screen" id="rts_03_0031__en-us_topic_0057973132_screen27988257">{
|
|
"metadata": {
|
|
"Name": "SmokeServer"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rts_03_0031__en-us_topic_0057973132_section24980457"><h4 class="sectiontitle">Return Code</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0031__en-us_topic_0057973117_table40445519194057" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Normal return code</caption><thead align="left"><tr id="rts_03_0031__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_0031__rts_03_0020_en-us_topic_0057973117_p13413377194057"><strong id="rts_03_0031__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_0031__rts_03_0020_en-us_topic_0057973117_p12741761194057"><strong id="rts_03_0031__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_0031__rts_03_0020_en-us_topic_0057973117_p25449701194057"><strong id="rts_03_0031__rts_03_0020_en-us_topic_0057973140_b842352706193020">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0031__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_0031__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_0031__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_0031__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_0031__table19512103414" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Error return code</caption><thead align="left"><tr id="rts_03_0031__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_0031__rts_03_0029_p129561510144"><strong id="rts_03_0031__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_0031__rts_03_0029_p4959810444"><strong id="rts_03_0031__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_0031__rts_03_0029_p9959161020418"><strong id="rts_03_0031__rts_03_0029_en-us_topic_0057973140_b842352706193020">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rts_03_0031__rts_03_0029_row179609103411"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0031__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_0031__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_0031__rts_03_0029_p9963110146">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0031__rts_03_0029_row181330274199"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0031__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_0031__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_0031__rts_03_0029_p11134162718196">Authorization failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rts_03_0031__rts_03_0029_row16531631121913"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0031__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_0031__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_0031__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>
|
|
|