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>
160 lines
13 KiB
HTML
160 lines
13 KiB
HTML
<a name="EN-US_TOPIC_0031169058"></a><a name="EN-US_TOPIC_0031169058"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Networks of a Specified <span id="text1187375825716">ECS</span></h1>
|
|
<div id="body1464590256141"><div class="section" id="EN-US_TOPIC_0031169058__section53922917165259"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0031169058__p5680132165259">This API is used to query the networks of an <span id="EN-US_TOPIC_0031169058__text42403381201">ECS</span>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169058__section64211377173223"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0031169058__p21448859173231">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169058__section51121191165259"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0031169058__p13981236132115">GET /v2.1/{project_id}/servers/{server_id}/ips</p>
|
|
<p id="EN-US_TOPIC_0031169058__p14621471348">GET /v2/{project_id}/servers/{server_id}/ips</p>
|
|
<div class="p" id="EN-US_TOPIC_0031169058__p196172031118"><a href="#EN-US_TOPIC_0031169058__table60562285165259">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0031169058__table60562285165259"></a><a name="table60562285165259"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0031169058__table60562285165259" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0031169058__row4861884165259"><th align="left" class="cellrowborder" valign="top" width="16.6%" id="mcps1.3.3.4.2.2.4.1.1"><p id="EN-US_TOPIC_0031169058__p5187119">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.349999999999998%" id="mcps1.3.3.4.2.2.4.1.2"><p id="EN-US_TOPIC_0031169058__p17503500">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="66.05%" id="mcps1.3.3.4.2.2.4.1.3"><p id="EN-US_TOPIC_0031169058__p8497414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0031169058__row63809876165259"><td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0031169058__p1217433165259">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0031169058__p31503226165259">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66.05%" headers="mcps1.3.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0031169058__p37593705">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0031169058__row14620905165259"><td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0031169058__p43442641165259">server_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0031169058__p29193009165259">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66.05%" headers="mcps1.3.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0031169058__p15823538165259">Specifies the <span id="EN-US_TOPIC_0031169058__text1840135720465">ECS</span> ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169058__section8194118165259"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0031169058__p46604243143912">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169058__section58140617165259"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0031169058__p64161330131216"><a href="#EN-US_TOPIC_0031169058__table53480673143936">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0031169058__table53480673143936"></a><a name="table53480673143936"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0031169058__table53480673143936" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0031169058__row28382388143936"><th align="left" class="cellrowborder" valign="top" width="18.75%" id="mcps1.3.5.3.2.5.1.1"><p id="EN-US_TOPIC_0031169058__p17272131143936">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.4%" id="mcps1.3.5.3.2.5.1.2"><p id="EN-US_TOPIC_0031169058__p5907101717224">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.629999999999999%" id="mcps1.3.5.3.2.5.1.3"><p id="EN-US_TOPIC_0031169058__p56865403143936">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.22%" id="mcps1.3.5.3.2.5.1.4"><p id="EN-US_TOPIC_0031169058__p35736067143936">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0031169058__row8940324143936"><td class="cellrowborder" valign="top" width="18.75%" headers="mcps1.3.5.3.2.5.1.1 "><p id="EN-US_TOPIC_0031169058__p53077645143936">addresses</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.4%" headers="mcps1.3.5.3.2.5.1.2 "><p id="EN-US_TOPIC_0031169058__p390718172226">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.629999999999999%" headers="mcps1.3.5.3.2.5.1.3 "><p id="EN-US_TOPIC_0031169058__p4322023143936">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.22%" headers="mcps1.3.5.3.2.5.1.4 "><p id="EN-US_TOPIC_0031169058__p36857741143936">Specifies the network address of the <span id="EN-US_TOPIC_0031169058__text47416588464">ECS</span>. For details, see <a href="#EN-US_TOPIC_0031169058__table56891490143956">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0031169058__table56891490143956"></a><a name="table56891490143956"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0031169058__table56891490143956" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0031169058__b84235270692526">addresses</strong> parameter structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0031169058__row33903869143956"><th align="left" class="cellrowborder" valign="top" width="18.77812218778122%" id="mcps1.3.5.4.2.5.1.1"><p id="EN-US_TOPIC_0031169058__p4503028171311">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.308269173082692%" id="mcps1.3.5.4.2.5.1.2"><p id="EN-US_TOPIC_0031169058__p107641620192214">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.688431156884313%" id="mcps1.3.5.4.2.5.1.3"><p id="EN-US_TOPIC_0031169058__p1150310281135">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.22517748225177%" id="mcps1.3.5.4.2.5.1.4"><p id="EN-US_TOPIC_0031169058__p205181728131313">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0031169058__row33776430143956"><td class="cellrowborder" valign="top" width="18.77812218778122%" headers="mcps1.3.5.4.2.5.1.1 "><p id="EN-US_TOPIC_0031169058__p51536339143956">Network address of the <span id="EN-US_TOPIC_0031169058__text1821459144615">ECS</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.308269173082692%" headers="mcps1.3.5.4.2.5.1.2 "><p id="EN-US_TOPIC_0031169058__p8764182011227">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.688431156884313%" headers="mcps1.3.5.4.2.5.1.3 "><p id="EN-US_TOPIC_0031169058__p13693953143956">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.22517748225177%" headers="mcps1.3.5.4.2.5.1.4 "><p id="EN-US_TOPIC_0031169058__p54366741143956">Specifies the network where the <span id="EN-US_TOPIC_0031169058__text3801155913460">ECS</span> accesses. For details about the network parameter, see <a href="#EN-US_TOPIC_0031169058__table22651992144025">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0031169058__table22651992144025"></a><a name="table22651992144025"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0031169058__table22651992144025" frame="border" border="1" rules="all"><caption><b>Table 4 </b><span id="EN-US_TOPIC_0031169058__text111414374712">ECS</span> network parameter structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0031169058__row15576094144025"><th align="left" class="cellrowborder" valign="top" width="15.151515151515152%" id="mcps1.3.5.5.2.7.1.1"><p id="EN-US_TOPIC_0031169058__p53704088144025">Attribute</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.111111111111112%" id="mcps1.3.5.5.2.7.1.2"><p id="EN-US_TOPIC_0031169058__p55063891144025">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.101010101010102%" id="mcps1.3.5.5.2.7.1.3"><p id="EN-US_TOPIC_0031169058__p30990199144025">CRUD</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.131313131313133%" id="mcps1.3.5.5.2.7.1.4"><p id="EN-US_TOPIC_0031169058__p27178154144025">Default Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.151515151515152%" id="mcps1.3.5.5.2.7.1.5"><p id="EN-US_TOPIC_0031169058__p53946903144025">Constraint</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="35.35353535353536%" id="mcps1.3.5.5.2.7.1.6"><p id="EN-US_TOPIC_0031169058__p7623012144025">Remarks</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0031169058__row1498246144025"><td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.5.5.2.7.1.1 "><p id="EN-US_TOPIC_0031169058__p54249095144025">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.111111111111112%" headers="mcps1.3.5.5.2.7.1.2 "><p id="EN-US_TOPIC_0031169058__p32100540144025">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.5.5.2.7.1.3 "><p id="EN-US_TOPIC_0031169058__p50006925144025">R</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.5.5.2.7.1.4 "><p id="EN-US_TOPIC_0031169058__p24029156144025">N/A</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.5.5.2.7.1.5 "><p id="EN-US_TOPIC_0031169058__p204582144025">4 or 6</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.35353535353536%" headers="mcps1.3.5.5.2.7.1.6 "><p id="EN-US_TOPIC_0031169058__p16571197144025">Specifies the IP address version. The value of this parameter can be <strong id="EN-US_TOPIC_0031169058__b50100560143815">4</strong> or <strong id="EN-US_TOPIC_0031169058__b62274100143818">6</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0031169058__row14923052144025"><td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.5.5.2.7.1.1 "><p id="EN-US_TOPIC_0031169058__p807709144025">addr</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.111111111111112%" headers="mcps1.3.5.5.2.7.1.2 "><p id="EN-US_TOPIC_0031169058__p65424470144025">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.101010101010102%" headers="mcps1.3.5.5.2.7.1.3 "><p id="EN-US_TOPIC_0031169058__p64890752144025">R</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.5.5.2.7.1.4 "><p id="EN-US_TOPIC_0031169058__p21659587144025">N/A</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.5.5.2.7.1.5 "><p id="EN-US_TOPIC_0031169058__p9596102144025">IP address format</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="35.35353535353536%" headers="mcps1.3.5.5.2.7.1.6 "><p id="EN-US_TOPIC_0031169058__p39086769144025">Specifies the IP address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169058__section852143516136"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0031169058__p29641413317">Query the networks of a specified ECS.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0031169058__screen19877494419">GET https://{endpoint}/v2/{project_id}/servers/{server_id}/ips
|
|
GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/ips</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169058__section101711934134020"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0031169058__screen134215347407">{
|
|
"addresses": {
|
|
"Network address of the ECS": [
|
|
{
|
|
"version": 4,
|
|
"addr": "10.176.42.16"
|
|
},
|
|
{
|
|
"version": 6,
|
|
"addr": "::babe:10.176.42.16"
|
|
}
|
|
]
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169058__section38817202165259"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0031169058__p57185677165259">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_0031167513.html">Network Management</a></div>
|
|
</div>
|
|
</div>
|
|
|