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

124 lines
8.9 KiB
HTML

<a name="rts_03_0047"></a><a name="rts_03_0047"></a>
<h1 class="topictitle1">Querying Resource Types</h1>
<div id="body1511161465561"><div class="section" id="rts_03_0047__en-us_topic_0057973149_section22362409"><h4 class="sectiontitle">Function</h4><p id="rts_03_0047__en-us_topic_0057973149_p32940684">This API is used to query resource types.</p>
</div>
<div class="section" id="rts_03_0047__en-us_topic_0057973149_section67043958"><h4 class="sectiontitle">URI</h4><p id="rts_03_0047__p76479013312">GET /v1/{project_id}/resource_types</p>
<p id="rts_03_0047__p2061172217314">For details about the parameters, see <a href="#rts_03_0047__table1759528275">Table 1</a>.</p>
<div class="tablenoborder"><a name="rts_03_0047__table1759528275"></a><a name="table1759528275"></a><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0047__table1759528275" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rts_03_0047__row26011272716"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.4.2.5.1.1"><p id="rts_03_0047__p17762534144716"><strong id="rts_03_0047__b103051051101219">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_0047__p376433420478"><strong id="rts_03_0047__b430485215122">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_0047__p15766123474714"><strong id="rts_03_0047__b7654533127">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_0047__p147683349474"><strong id="rts_03_0047__b12893453141210">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0047__row10601725277"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.1 "><p id="rts_03_0047__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_0047__p0655184916104">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.3 "><p id="rts_03_0047__p865694971017">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.4.2.5.1.4 "><p id="rts_03_0047__p13658144921010">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rts_03_0047__en-us_topic_0057973149_section66524715"><h4 class="sectiontitle">Request Parameter</h4><p id="rts_03_0047__p9290352916">N/A</p>
</div>
<div class="section" id="rts_03_0047__en-us_topic_0057973149_section61851530"><h4 class="sectiontitle">Response Parameter</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0047__en-us_topic_0057973149_table40331056" frame="border" border="1" rules="all"><thead align="left"><tr id="rts_03_0047__en-us_topic_0057973149_row44895264"><th align="left" class="cellrowborder" valign="top" width="15.478452154784522%" id="mcps1.3.4.2.1.5.1.1"><p id="rts_03_0047__p13701251185014"><strong id="rts_03_0047__b539517117139">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.478452154784522%" id="mcps1.3.4.2.1.5.1.2"><p id="rts_03_0047__p13704145119507"><strong id="rts_03_0047__b33678216136">In</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.478452154784522%" id="mcps1.3.4.2.1.5.1.3"><p id="rts_03_0047__p3705151185017"><strong id="rts_03_0047__b230317313137">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.564643535646425%" id="mcps1.3.4.2.1.5.1.4"><p id="rts_03_0047__p1371214511507"><strong id="rts_03_0047__b1621717431313">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0047__en-us_topic_0057973149_row1734575"><td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.1 "><p id="rts_03_0047__en-us_topic_0057973149_p6282875">resource_types</p>
</td>
<td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.2 "><p id="rts_03_0047__p9171630123118">body</p>
</td>
<td class="cellrowborder" valign="top" width="15.478452154784522%" headers="mcps1.3.4.2.1.5.1.3 "><p id="rts_03_0047__en-us_topic_0057973149_p39150827">List &lt;str&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.564643535646425%" headers="mcps1.3.4.2.1.5.1.4 "><p id="rts_03_0047__en-us_topic_0057973149_p42954456">Specifies the resource type list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="rts_03_0047__en-us_topic_0057973149_section19792858"><h4 class="sectiontitle">Request Example</h4><pre class="screen" id="rts_03_0047__en-us_topic_0057973149_screen56758950">GET /v1/95d02433133a4c0a87ba6967474a2ad3/resource_types</pre>
</div>
<div class="section" id="rts_03_0047__en-us_topic_0057973149_section43917997"><h4 class="sectiontitle">Response Example</h4><pre class="screen" id="rts_03_0047__en-us_topic_0057973149_screen48812368112954">{
"resource_types": [
"OS::Nova::Server",
"OS::Neutron::Net",
"OS::Neutron::Port",
"OS::Cinder::VolumeAttachment",
"OS::Neutron::RouterInterface",
"OS::Neutron::Router"
]
}</pre>
</div>
<div class="section" id="rts_03_0047__en-us_topic_0057973149_section59717661"><h4 class="sectiontitle">Return Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rts_03_0047__table01411862119" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Normal return code</caption><thead align="left"><tr id="rts_03_0047__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_0047__rts_03_0020_en-us_topic_0057973117_p13413377194057"><strong id="rts_03_0047__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_0047__rts_03_0020_en-us_topic_0057973117_p12741761194057"><strong id="rts_03_0047__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_0047__rts_03_0020_en-us_topic_0057973117_p25449701194057"><strong id="rts_03_0047__rts_03_0020_en-us_topic_0057973140_b842352706193020">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0047__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_0047__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_0047__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_0047__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_0047__table19512103414" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Error return code</caption><thead align="left"><tr id="rts_03_0047__row16955110342"><th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.7.3.2.4.1.1"><p id="rts_03_0047__p129561510144">Return Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.7.3.2.4.1.2"><p id="rts_03_0047__p4959810444"><strong id="rts_03_0047__b2987612181317">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_0047__p9959161020418"><strong id="rts_03_0047__b105914149137">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rts_03_0047__row179609103411"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0047__p896118101840">400</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0047__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_0047__p9963110146">The server failed to process the request.</p>
</td>
</tr>
<tr id="rts_03_0047__row181330274199"><td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.7.3.2.4.1.1 "><p id="rts_03_0047__p18134027201912">401</p>
</td>
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.7.3.2.4.1.2 "><p id="rts_03_0047__p1713419274191">Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.7.3.2.4.1.3 "><p id="rts_03_0047__p11134162718196">Authorization failed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rts_03_0062.html">Resource Type Management</a></div>
</div>
</div>