forked from docs/doc-exports
Zaoxu, Li
4edaa4a4cc
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com> Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com> Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
129 lines
11 KiB
HTML
129 lines
11 KiB
HTML
<a name="EN-US_TOPIC_0175597847"></a><a name="EN-US_TOPIC_0175597847"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About an <span id="text1217010211513">ECS</span> Group</h1>
|
|
<div id="body1560936331296"><div class="section" id="EN-US_TOPIC_0175597847__en-us_topic_0057973159_section30240326"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0175597847__en-us_topic_0057973159_p8477413">This API is used to query details bout an <span id="EN-US_TOPIC_0175597847__text1864145105112">ECS</span> group.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0175597847__en-us_topic_0057973159_section3727484"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0175597847__en-us_topic_0057973159_p17835728145012">GET /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}</p>
|
|
<div class="p" id="EN-US_TOPIC_0175597847__p78871242155711"><a href="#EN-US_TOPIC_0175597847__table050833691012">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0175597847__table050833691012"></a><a name="table050833691012"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0175597847__table050833691012" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0175597847__row15081536181020"><th align="left" class="cellrowborder" valign="top" width="21.372137213721373%" id="mcps1.3.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0175597847__p1955795061017">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.152015201520154%" id="mcps1.3.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0175597847__p1855735010105">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.475847584758476%" id="mcps1.3.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0175597847__p9557135012109">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0175597847__row19508183616103"><td class="cellrowborder" valign="top" width="21.372137213721373%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0175597847__p55578506107">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.152015201520154%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0175597847__p115571850201017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.475847584758476%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0175597847__p85571250121016">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0175597847__row165801546171015"><td class="cellrowborder" valign="top" width="21.372137213721373%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0175597847__p95579501105">server_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.152015201520154%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0175597847__p1855755014100">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.475847584758476%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0175597847__p175571650101019">Specifies an <span id="EN-US_TOPIC_0175597847__text75573505108">ECS</span> group UUID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0175597847__section1383316545593"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0175597847__p615975835913">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0175597847__en-us_topic_0057973159_section28398296"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0175597847__p04915845812"><a href="#EN-US_TOPIC_0175597847__table4683214181116">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0175597847__table4683214181116"></a><a name="table4683214181116"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0175597847__table4683214181116" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0175597847__row19683151441112"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0175597847__p18575171791110">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.842884288428845%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0175597847__p1557541731119">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.95509550955095%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0175597847__p1657571781115">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0175597847__row1368331481114"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0175597847__p135751917111115">server_group</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.842884288428845%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0175597847__p11575101711116">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.95509550955095%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0175597847__p55752017101118">Specifies the <span id="EN-US_TOPIC_0175597847__text7575171711115">ECS</span> group information. For details, see <a href="#EN-US_TOPIC_0175597847__en-us_topic_0057973159_table5520021">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0175597847__en-us_topic_0057973159_table5520021"></a><a name="en-us_topic_0057973159_table5520021"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0175597847__en-us_topic_0057973159_table5520021" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0175597847__b46695205508">server_group</strong> parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0175597847__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_0175597847__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_0175597847__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_0175597847__p168651757112614">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0175597847__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_0175597847__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_0175597847__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_0175597847__en-us_topic_0057973159_p56454382">Specifies an <span id="EN-US_TOPIC_0175597847__text1276417562511">ECS</span> group UUID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0175597847__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_0175597847__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_0175597847__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_0175597847__en-us_topic_0057973159_p5596939">Specifies the <span id="EN-US_TOPIC_0175597847__text1334355535210">ECS</span> group name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0175597847__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_0175597847__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_0175597847__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 "><p id="EN-US_TOPIC_0175597847__en-us_topic_0057973159_p31957059">Specifies the policies associated with the <span id="EN-US_TOPIC_0175597847__text8226656205217">ECS</span> group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0175597847__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_0175597847__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_0175597847__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_0175597847__en-us_topic_0057973159_p8656215">Specifies the <span id="EN-US_TOPIC_0175597847__text1112285820524">ECS</span> contained in an <span id="EN-US_TOPIC_0175597847__text131862575529">ECS</span> group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0175597847__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_0175597847__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_0175597847__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_0175597847__en-us_topic_0057973159_p43657808">Specifies the <span id="EN-US_TOPIC_0175597847__text4695587520">ECS</span> group metadata.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0175597847__en-us_topic_0057973159_section54258073"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0175597847__p18811913118">Query details about a specified ECS group.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0175597847__screen1447313139599">GET https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups/{server_group_id}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0175597847__section682201453619"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0175597847__screen138910147365">{
|
|
"server_group": {
|
|
"id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
|
|
"name": "test",
|
|
"policies": ["anti-affinity"],
|
|
"members": [],
|
|
"metadata": {}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0175597847__en-us_topic_0057973159_section32827787"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0175597847__en-us_topic_0057973159_p22638273583">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0175597847__section85821649202813"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0175597847__p7233105282813">See <a href="en-us_topic_0022067717.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0161097717.html">ECS Group Management</a></div>
|
|
</div>
|
|
</div>
|
|
|