vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ecs/api-ref/en-us_topic_0065817722.html
Goncharov, Artem e804cc1855 ecs api-ref update from https://github.com/opentelekomcloud-docs/doc-exports/pull/13/ 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Goncharov, Artem <artem.goncharov@t-systems.com>
Co-committed-by: Goncharov, Artem <artem.goncharov@t-systems.com>
2022-08-17 15:16:30 +00:00

146 lines
13 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0065817722"></a><a name="EN-US_TOPIC_0065817722"></a>
<h1 class="topictitle1">Querying Details About an <span id="text1616518462548">ECS</span> Group</h1>
<div id="body1499652824863"><div class="section" id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_section30240326"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p8477413">This API is used to query details bout an <span id="EN-US_TOPIC_0065817722__text168429171381">ECS</span> group.</p>
</div>
<div class="section" id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_section3727484"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p17835728145012">GET /v2.1/{project_id}/os-server-groups/{server_group_id}</p>
<p id="EN-US_TOPIC_0065817722__p1133114348217">GET /v2/{project_id}/os-server-groups/{server_group_id}</p>
<div class="p" id="EN-US_TOPIC_0065817722__p78871242155711"><a href="#EN-US_TOPIC_0065817722__table1773113411618">Table 1</a> describes the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817722__table1773113411618"></a><a name="table1773113411618"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817722__table1773113411618" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0065817722__row2073173419165"><th align="left" class="cellrowborder" valign="top" width="23.342334233423344%" id="mcps1.3.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0065817722__p1734664216169">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.202120212021203%" id="mcps1.3.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0065817722__p11346124271610">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.45554555455545%" id="mcps1.3.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0065817722__p11346104220163">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817722__row1773534141610"><td class="cellrowborder" valign="top" width="23.342334233423344%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065817722__p83465429162">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.202120212021203%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065817722__p63461542141612">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.45554555455545%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065817722__p18346124231612">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817722__row1373153419161"><td class="cellrowborder" valign="top" width="23.342334233423344%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065817722__p193461542111617">server_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.202120212021203%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065817722__p734764214164">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.45554555455545%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065817722__p1034714281618">Specifies the <span id="EN-US_TOPIC_0065817722__text443520261287">ECS</span> group UUID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065817722__section7947182095214"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0065817722__p19302182416521">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_section28398296"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0065817722__p04915845812"><a href="#EN-US_TOPIC_0065817722__table176896216171">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817722__table176896216171"></a><a name="table176896216171"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817722__table176896216171" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065817722__row136891322172"><th align="left" class="cellrowborder" valign="top" width="27.792779277927792%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0065817722__p18622612101716">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.342734273427343%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0065817722__p76221812141711">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.86448644864487%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0065817722__p462291231718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817722__row468942121713"><td class="cellrowborder" valign="top" width="27.792779277927792%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817722__p1622161215175">server_group</p>
</td>
<td class="cellrowborder" valign="top" width="27.342734273427343%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817722__p11622171219171">Object</p>
</td>
<td class="cellrowborder" valign="top" width="44.86448644864487%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817722__p12622131215171">Specifies the <span id="EN-US_TOPIC_0065817722__text1562213126175">ECS</span> group information. For details, see <a href="#EN-US_TOPIC_0065817722__en-us_topic_0057973159_table5520021">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817722__en-us_topic_0057973159_table5520021"></a><a name="en-us_topic_0057973159_table5520021"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_table5520021" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0065817722__b842352706162245">server_group</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_row52947946"><th align="left" class="cellrowborder" valign="top" width="30.09%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0065817722__p14850105762611">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.09%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0065817722__p1685014574266">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.82%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0065817722__p168651757112614">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_row5110742"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p11316939">id</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p44256881">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p56454382">Specifies the <span id="EN-US_TOPIC_0065817722__text10146155513811">ECS</span> group UUID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_row38327398"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p17511496">name</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p9145087">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p5596939">Specifies the <span id="EN-US_TOPIC_0065817722__text11331337916">ECS</span> group name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_row50372456"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p53637170">policies</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p49643541">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.4.2.4.1.3 "><div class="p" id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p31957059">Specifies the policies associated with the <span id="EN-US_TOPIC_0065817722__text18623659915">ECS</span> group.<ul id="EN-US_TOPIC_0065817722__en-us_topic_0057973153_ul1237514118527"><li id="EN-US_TOPIC_0065817722__en-us_topic_0057973153_li1374711155217"><strong id="EN-US_TOPIC_0065817722__b647223191318">anti-affinity</strong>: <span id="EN-US_TOPIC_0065817722__text104784381313">ECS</span>s in this group must be deployed on different hosts.</li></ul>
</div>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_row19178079"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p9920603">members</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p65371346">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p8656215">Specifies the <span id="EN-US_TOPIC_0065817722__text990715511124">ECS</span>s contained in the <span id="EN-US_TOPIC_0065817722__text1063465220219">ECS</span> group.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_row10797076"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p2147930">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p39764641">Object</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p43657808">Specifies the <span id="EN-US_TOPIC_0065817722__text781018225915">ECS</span> group metadata.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_row57375958"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p16941010">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p30044530">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p23428799">Specifies the tenant ID in UUID format for the <span id="EN-US_TOPIC_0065817722__text148814271593">ECS</span> group.</p>
<p id="EN-US_TOPIC_0065817722__p1873011156514">This parameter is supported in microversion 2.13 and later.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_row975381085117"><td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p187549109517">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="30.09%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p090181716517">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.82%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p39217176512">Specifies the user ID in UUID format for the <span id="EN-US_TOPIC_0065817722__text7507163119911">ECS</span> group.</p>
<p id="EN-US_TOPIC_0065817722__p01189312816">This parameter is supported in microversion 2.13 and later.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_section54258073"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0065817722__screen1447313139599">GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9
GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9</pre>
</div>
<div class="section" id="EN-US_TOPIC_0065817722__section8761640135117"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0065817722__screen484124055112">{
"server_group": {
"id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
"name": "test",
"policies": ["anti-affinity"],
"members": [],
"metadata": {},
"project_id": "9c53a566cb3443ab910cf0daebca90c4"
}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_section32827787"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0065817722__en-us_topic_0057973159_p22638273583">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_0065817683.html">ECS Group Management</a></div>
</div>
</div>
View Git Blame Copy Permalink