doc-exports/docs/ecs/api-ref/en-us_topic_0020212659.html
Artem Goncharov 3196b64bfc
move doc sources to other location (#3)
move doc sources to other location

Reviewed-by: OpenTelekomCloud Bot <None>
2022-04-27 16:24:25 +00:00

226 lines
18 KiB
HTML

<a name="EN-US_TOPIC_0020212659"></a><a name="EN-US_TOPIC_0020212659"></a>
<h1 class="topictitle1">Querying Details About an <span id="text17370108184918">ECS</span> Flavor</h1>
<div id="body21209668"><div class="section" id="EN-US_TOPIC_0020212659__section64833508"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0020212659__p40261524">This API is used to query the details about an <span id="EN-US_TOPIC_0020212659__text021012994920">ECS</span> flavor based on the flavor ID.</p>
</div>
<div class="section" id="EN-US_TOPIC_0020212659__section46630661"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0020212659__p9351181414818">GET /v2.1/{project_id}/flavors/{flavor_id}</p>
<p id="EN-US_TOPIC_0020212659__p6399145113254">GET /v2/{project_id}/flavors/{flavor_id}</p>
<div class="p" id="EN-US_TOPIC_0020212659__p097815451858"><a href="#EN-US_TOPIC_0020212659__table47154420">Table 1</a> describes the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212659__table47154420"></a><a name="table47154420"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212659__table47154420" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212659__row324668"><th align="left" class="cellrowborder" valign="top" width="16.98%" id="mcps1.3.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0020212659__p5187119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.16%" id="mcps1.3.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0020212659__p17503500">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="65.86%" id="mcps1.3.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0020212659__p8497414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020212659__row17004965"><td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p35224963">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.16%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p34649765">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="65.86%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p37593705">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row26746391"><td class="cellrowborder" valign="top" width="16.98%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p18974100">flavors_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.16%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p60507121">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="65.86%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p2129750">Specifies the flavor ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0020212659__section17022773"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0020212659__p9084369">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0020212659__section18987236"><h4 class="sectiontitle">Response</h4><div class="p" id="EN-US_TOPIC_0020212659__p1022715161565"><a href="#EN-US_TOPIC_0020212659__table61695723">Table 2</a> describes the response parameters.
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212659__table61695723"></a><a name="table61695723"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212659__table61695723" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0020212659__row52977523"><th align="left" class="cellrowborder" valign="top" width="16.85%" id="mcps1.3.4.2.2.2.4.1.1"><p id="EN-US_TOPIC_0020212659__p110452114597">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.29%" id="mcps1.3.4.2.2.2.4.1.2"><p id="EN-US_TOPIC_0020212659__p71044217595">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="66.86%" id="mcps1.3.4.2.2.2.4.1.3"><p id="EN-US_TOPIC_0020212659__p15104102175910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020212659__row2794650"><td class="cellrowborder" valign="top" width="16.85%" headers="mcps1.3.4.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p25040094">flavor</p>
</td>
<td class="cellrowborder" valign="top" width="16.29%" headers="mcps1.3.4.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p5563313">Object</p>
</td>
<td class="cellrowborder" valign="top" width="66.86%" headers="mcps1.3.4.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p29123463">Specifies the <span id="EN-US_TOPIC_0020212659__text94471119492">ECS</span> flavor. For details, see <a href="#EN-US_TOPIC_0020212659__table20109663">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212659__table20109663"></a><a name="table20109663"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212659__table20109663" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong>flavor</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212659__row50842877"><th align="left" class="cellrowborder" valign="top" width="16.86%" id="mcps1.3.4.2.3.2.4.1.1"><p id="EN-US_TOPIC_0020212659__p1011213912218">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.2%" id="mcps1.3.4.2.3.2.4.1.2"><p id="EN-US_TOPIC_0020212659__p111215914215">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="66.94%" id="mcps1.3.4.2.3.2.4.1.3"><p id="EN-US_TOPIC_0020212659__p121121091925">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020212659__row37029065"><td class="cellrowborder" valign="top" width="16.86%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p46564252">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.2%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p28514710">String</p>
</td>
<td class="cellrowborder" valign="top" width="66.94%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p50584809">Specifies the ID of the <span id="EN-US_TOPIC_0020212659__text5500625162510">ECS</span> flavor.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row52610097"><td class="cellrowborder" valign="top" width="16.86%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p33559471">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.2%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p66621782">String</p>
</td>
<td class="cellrowborder" valign="top" width="66.94%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p47570623">Specifies the name of the <span id="EN-US_TOPIC_0020212659__text8787428162513">ECS</span> flavor.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row12413842183117"><td class="cellrowborder" valign="top" width="16.86%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p184132423315">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.2%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p11413142153116">String</p>
</td>
<td class="cellrowborder" valign="top" width="66.94%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p1941384233119">Describes the <span id="EN-US_TOPIC_0020212659__text5890141234918">ECS</span> flavor.</p>
<p id="EN-US_TOPIC_0020212659__p210419138321">This parameter is supported in microversion 2.55 and later.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row25482430"><td class="cellrowborder" valign="top" width="16.86%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p50810959">vcpus</p>
</td>
<td class="cellrowborder" valign="top" width="16.2%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p40977906">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="66.94%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p9449599">Specifies the number of vCPUs in the <span id="EN-US_TOPIC_0020212659__text145651219261">ECS</span> flavor.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row2289826710437"><td class="cellrowborder" valign="top" width="16.86%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p6260494310453">ram</p>
</td>
<td class="cellrowborder" valign="top" width="16.2%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p3783561810453">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="66.94%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p42285210453">Specifies the memory size (MB) in the <span id="EN-US_TOPIC_0020212659__text7164902615">ECS</span> flavor.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row17937528"><td class="cellrowborder" valign="top" width="16.86%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p43653635">disk</p>
</td>
<td class="cellrowborder" valign="top" width="16.2%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p57980147">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="66.94%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p56052334">Specifies the system disk size in the <span id="EN-US_TOPIC_0020212659__text41931211172617">ECS</span> flavor.</p>
<p id="EN-US_TOPIC_0020212659__p34708966">This parameter has not been used. Its default value is <strong id="EN-US_TOPIC_0020212659__b84235270611135">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row43945239"><td class="cellrowborder" valign="top" width="16.86%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p2794612">swap</p>
</td>
<td class="cellrowborder" valign="top" width="16.2%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p14734188">String</p>
</td>
<td class="cellrowborder" valign="top" width="66.94%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p1699362755013">Specifies the swap partition size required by the <span id="EN-US_TOPIC_0020212659__text72931213192619">ECS</span> flavor.</p>
<p id="EN-US_TOPIC_0020212659__p4563766173425">This parameter has not been used. Its default value is <strong id="EN-US_TOPIC_0020212659__b1169184476">""</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row34246806"><td class="cellrowborder" valign="top" width="16.86%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p22527890">OS-FLV-EXT-DATA:ephemeral</p>
</td>
<td class="cellrowborder" valign="top" width="16.2%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p31767774">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="66.94%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p16591226713">Specifies the temporary disk size. This is an extended attribute.</p>
<p id="EN-US_TOPIC_0020212659__p1140814148017">This parameter has not been used. Its default value is <strong id="EN-US_TOPIC_0020212659__b1551023403">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row55347837"><td class="cellrowborder" valign="top" width="16.86%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p53989823">OS-FLV-DISABLED:disabled</p>
</td>
<td class="cellrowborder" valign="top" width="16.2%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p26649649">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="66.94%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p32761310192019">Specifies whether the <span id="EN-US_TOPIC_0020212659__text25831622613">ECS</span> flavor has been disabled. This is an extended attribute.</p>
<p id="EN-US_TOPIC_0020212659__p182115151112">This parameter has not been used. Its default value is <strong id="EN-US_TOPIC_0020212659__b1253412489">false</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row29760277"><td class="cellrowborder" valign="top" width="16.86%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p61772230">rxtx_factor</p>
</td>
<td class="cellrowborder" valign="top" width="16.2%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p17171756">Float</p>
</td>
<td class="cellrowborder" valign="top" width="66.94%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p16772171313154">Specifies the ratio of the available network bandwidth to the network hardware bandwidth of the <span id="EN-US_TOPIC_0020212659__text1837182022619">ECS</span>.</p>
<p id="EN-US_TOPIC_0020212659__p3711880173425">This parameter has not been used. Its default value is <strong id="EN-US_TOPIC_0020212659__b993945157">1.0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row5115727"><td class="cellrowborder" valign="top" width="16.86%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p11720763">os-flavor-access:is_public</p>
</td>
<td class="cellrowborder" valign="top" width="16.2%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p60282721">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="66.94%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p8894218182818">Specifies whether a flavor is available to all tenants. This is an extended attribute.</p>
<ul id="EN-US_TOPIC_0020212659__ul1474014143815"><li id="EN-US_TOPIC_0020212659__li174051412817"><strong id="EN-US_TOPIC_0020212659__b84235270620200">true</strong>: indicates that a flavor is available to all tenants.</li><li id="EN-US_TOPIC_0020212659__li974011141783"><strong id="EN-US_TOPIC_0020212659__b764423780">false</strong>: indicates that a flavor is available only to certain tenants.</li></ul>
<p id="EN-US_TOPIC_0020212659__p35038271466">Default value: <strong id="EN-US_TOPIC_0020212659__b842352706115252">true</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row57014372193259"><td class="cellrowborder" valign="top" width="16.86%" headers="mcps1.3.4.2.3.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p1587802219356">links</p>
</td>
<td class="cellrowborder" valign="top" width="16.2%" headers="mcps1.3.4.2.3.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p1105141919356">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="66.94%" headers="mcps1.3.4.2.3.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p342100019356">Specifies shortcut links for ECS flavors. For details, see <a href="#EN-US_TOPIC_0020212659__table35514108193545">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0020212659__table35514108193545"></a><a name="table35514108193545"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020212659__table35514108193545" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong>links</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0020212659__row23367815193545"><th align="left" class="cellrowborder" valign="top" width="17.05%" id="mcps1.3.4.2.4.2.4.1.1"><p id="EN-US_TOPIC_0020212659__p98047153213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.29%" id="mcps1.3.4.2.4.2.4.1.2"><p id="EN-US_TOPIC_0020212659__p188041415328">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="66.66%" id="mcps1.3.4.2.4.2.4.1.3"><p id="EN-US_TOPIC_0020212659__p17804181511210">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020212659__row37879124193545"><td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.4.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p48310227193545">rel</p>
</td>
<td class="cellrowborder" valign="top" width="16.29%" headers="mcps1.3.4.2.4.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p20814310193545">String</p>
</td>
<td class="cellrowborder" valign="top" width="66.66%" headers="mcps1.3.4.2.4.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p8237558193545">Specifies the shortcut link marker name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020212659__row7029160193545"><td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.4.2.4.2.4.1.1 "><p id="EN-US_TOPIC_0020212659__p32491069193545">href</p>
</td>
<td class="cellrowborder" valign="top" width="16.29%" headers="mcps1.3.4.2.4.2.4.1.2 "><p id="EN-US_TOPIC_0020212659__p14530947193545">String</p>
</td>
<td class="cellrowborder" valign="top" width="66.66%" headers="mcps1.3.4.2.4.2.4.1.3 "><p id="EN-US_TOPIC_0020212659__p36156065193545">Provides the corresponding shortcut link.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0020212659__section17318173018714"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0020212659__en-us_topic_0057973030_screen28983216540">GET https://<em id="EN-US_TOPIC_0020212659__i5452131772714">{endpoint}</em>/v2/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2
GET https://<em id="EN-US_TOPIC_0020212659__i2290172712485">{endpoint}</em>/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2</pre>
</div>
<div class="section" id="EN-US_TOPIC_0020212659__section17459730163216"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0020212659__screen547413308329">{
"flavor": {
"name": "c3.2xlarge.2",
"links": [
{
"href": "https://compute.region.xxx.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2",
"rel": "self"
},
{
"href": "https://compute.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2",
"rel": "bookmark"
}
],
"ram": 16384,
"OS-FLV-DISABLED:disabled": false,
"vcpus": 8,
"swap": "",
"os-flavor-access:is_public": true,
"rxtx_factor": 1,
"OS-FLV-EXT-DATA:ephemeral": 0,
"disk": 0,
"id": "c3.2xlarge.2"
}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0020212659__section36667404"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0020212659__p49289224">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0020212655.html">Flavor Management</a></div>
</div>
</div>