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>
156 lines
12 KiB
HTML
156 lines
12 KiB
HTML
<a name="EN-US_TOPIC_0031169059"></a><a name="EN-US_TOPIC_0031169059"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Specified Network of an <span id="text144828397016">ECS</span></h1>
|
|
<div id="body1464590256141"><div class="section" id="EN-US_TOPIC_0031169059__section53922917165259"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0031169059__p5680132165259">This API is used to query the specified network of an <span id="EN-US_TOPIC_0031169059__text12811104020017">ECS</span>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169059__section64211377173223"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0031169059__p21448859173231">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169059__section51121191165259"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0031169059__p065620479212">GET /v2.1/{project_id}/servers/{server_id}/ips/{networkName}</p>
|
|
<p id="EN-US_TOPIC_0031169059__p16512182116345">GET /v2/{project_id}/servers/{server_id}/ips/{networkName}</p>
|
|
<div class="p" id="EN-US_TOPIC_0031169059__p13418120181516"><a href="#EN-US_TOPIC_0031169059__table60562285165259">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0031169059__table60562285165259"></a><a name="table60562285165259"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0031169059__table60562285165259" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0031169059__row4861884165259"><th align="left" class="cellrowborder" valign="top" width="18.48%" id="mcps1.3.3.4.2.2.4.1.1"><p id="EN-US_TOPIC_0031169059__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_0031169059__p17503500">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.17%" id="mcps1.3.3.4.2.2.4.1.3"><p id="EN-US_TOPIC_0031169059__p8497414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0031169059__row63809876165259"><td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0031169059__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_0031169059__p31503226165259">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.17%" headers="mcps1.3.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0031169059__p37593705">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0031169059__table1051945864112" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0031169059__row13519135844110"><th align="left" class="cellrowborder" valign="top" width="18.459999999999997%" id="mcps1.3.4.2.5.1.1"><p id="EN-US_TOPIC_0031169059__p1494123091511">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.22%" id="mcps1.3.4.2.5.1.2"><p id="EN-US_TOPIC_0031169059__p9494630131514">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.120000000000001%" id="mcps1.3.4.2.5.1.3"><p id="EN-US_TOPIC_0031169059__p19764237111514">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.2%" id="mcps1.3.4.2.5.1.4"><p id="EN-US_TOPIC_0031169059__p6494030121520">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0031169059__row6533658174112"><td class="cellrowborder" valign="top" width="18.459999999999997%" headers="mcps1.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0031169059__p11533958134116">server_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.22%" headers="mcps1.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0031169059__p19533958124119">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.120000000000001%" headers="mcps1.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0031169059__p9764153718155">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.2%" headers="mcps1.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0031169059__p12533558154116">Specifies the <span id="EN-US_TOPIC_0031169059__text1728211712473">ECS</span> ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0031169059__row85331158174111"><td class="cellrowborder" valign="top" width="18.459999999999997%" headers="mcps1.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0031169059__p1153315585416">networkName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.22%" headers="mcps1.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0031169059__p195337587419">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.120000000000001%" headers="mcps1.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0031169059__p87642037171514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.2%" headers="mcps1.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0031169059__p15339586411">Specifies the <span id="EN-US_TOPIC_0031169059__text173185471">ECS</span> network name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169059__section169561520543"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0031169059__p15391215131613">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169059__section58140617165259"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0031169059__p1437533219207"><a href="#EN-US_TOPIC_0031169059__table56891490143956">Table 3</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0031169059__table56891490143956"></a><a name="table56891490143956"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0031169059__table56891490143956" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0031169059__row33903869143956"><th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.6.3.2.4.1.1"><p id="EN-US_TOPIC_0031169059__p61858896143956">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.649999999999999%" id="mcps1.3.6.3.2.4.1.2"><p id="EN-US_TOPIC_0031169059__p44514659143956">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="66.62%" id="mcps1.3.6.3.2.4.1.3"><p id="EN-US_TOPIC_0031169059__p2902506143956">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0031169059__row33776430143956"><td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.6.3.2.4.1.1 "><p id="EN-US_TOPIC_0031169059__p51536339143956">Network address of the <span id="EN-US_TOPIC_0031169059__text13111131332716">ECS</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.649999999999999%" headers="mcps1.3.6.3.2.4.1.2 "><p id="EN-US_TOPIC_0031169059__p13693953143956">List(Dict)</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="66.62%" headers="mcps1.3.6.3.2.4.1.3 "><p id="EN-US_TOPIC_0031169059__p54366741143956">Specifies the network where the <span id="EN-US_TOPIC_0031169059__text16849182072716">ECS</span> accesses. For details about the network, see <a href="#EN-US_TOPIC_0031169059__table22651992144025">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0031169059__table22651992144025"></a><a name="table22651992144025"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0031169059__table22651992144025" frame="border" border="1" rules="all"><caption><b>Table 4 </b><span id="EN-US_TOPIC_0031169059__text1393341318478">ECS</span> network parameter structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0031169059__row15576094144025"><th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.6.4.2.7.1.1"><p id="EN-US_TOPIC_0031169059__p53704088144025">Attribute</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.881188118811881%" id="mcps1.3.6.4.2.7.1.2"><p id="EN-US_TOPIC_0031169059__p55063891144025">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.891089108910892%" id="mcps1.3.6.4.2.7.1.3"><p id="EN-US_TOPIC_0031169059__p30990199144025">CRUD</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.881188118811881%" id="mcps1.3.6.4.2.7.1.4"><p id="EN-US_TOPIC_0031169059__p27178154144025">Default Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.831683168316832%" id="mcps1.3.6.4.2.7.1.5"><p id="EN-US_TOPIC_0031169059__p53946903144025">Constraint</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.663366336633665%" id="mcps1.3.6.4.2.7.1.6"><p id="EN-US_TOPIC_0031169059__p7623012144025">Remarks</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0031169059__row1498246144025"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.4.2.7.1.1 "><p id="EN-US_TOPIC_0031169059__p54249095144025">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.6.4.2.7.1.2 "><p id="EN-US_TOPIC_0031169059__p32100540144025">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.891089108910892%" headers="mcps1.3.6.4.2.7.1.3 "><p id="EN-US_TOPIC_0031169059__p50006925144025">R</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.6.4.2.7.1.4 "><p id="EN-US_TOPIC_0031169059__p24029156144025">N/A</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.6.4.2.7.1.5 "><p id="EN-US_TOPIC_0031169059__p204582144025">4 or 6</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.6.4.2.7.1.6 "><p id="EN-US_TOPIC_0031169059__p16571197144025">Specifies the IP address version. The value of this parameter can be <strong id="EN-US_TOPIC_0031169059__b49505674143946">4</strong> or <strong id="EN-US_TOPIC_0031169059__b32947804143949">6</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0031169059__row14923052144025"><td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.6.4.2.7.1.1 "><p id="EN-US_TOPIC_0031169059__p807709144025">addr</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.6.4.2.7.1.2 "><p id="EN-US_TOPIC_0031169059__p65424470144025">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.891089108910892%" headers="mcps1.3.6.4.2.7.1.3 "><p id="EN-US_TOPIC_0031169059__p64890752144025">R</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.881188118811881%" headers="mcps1.3.6.4.2.7.1.4 "><p id="EN-US_TOPIC_0031169059__p21659587144025">N/A</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.831683168316832%" headers="mcps1.3.6.4.2.7.1.5 "><p id="EN-US_TOPIC_0031169059__p9596102144025">IP address format</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.6.4.2.7.1.6 "><p id="EN-US_TOPIC_0031169059__p39086769144025">Specifies the IP address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169059__section970712100142"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0031169059__p102388810415">Query the specified network of a specified ECS.</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0031169059__screen19381162514610">GET https://{endpoint}/v2/{project_id}/servers/{server_id}/ips/{networkName}
|
|
GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/ips/{networkName}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169059__section14612172044110"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0031169059__screen206441320154116">{
|
|
"Network address of the <span id="EN-US_TOPIC_0031169059__text078419163211">ECS</span>": [
|
|
{
|
|
"version": 4,
|
|
"addr": "10.0.0.4"
|
|
},
|
|
{
|
|
"version": 4,
|
|
"addr": "192.150.73.132"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0031169059__section38817202165259"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0031169059__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>
|
|
|