forked from docs/doc-exports
Qin Ying, Fan
310d2d9eb1
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com> Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>
146 lines
12 KiB
HTML
146 lines
12 KiB
HTML
<a name="vpc_privateip_0002"></a><a name="vpc_privateip_0002"></a>
|
|
|
|
<h1 class="topictitle1">Querying Private IP Address Details</h1>
|
|
<div id="body38735241"><div class="section" id="vpc_privateip_0002__section9185002"><h4 class="sectiontitle">Function</h4><p id="vpc_privateip_0002__p50546803">This API is used to query details about a private IP address using the specified ID.</p>
|
|
</div>
|
|
<div class="section" id="vpc_privateip_0002__section15556157"><h4 class="sectiontitle">URI</h4><p id="vpc_privateip_0002__p1624711517325">GET /v1/{project_id}/privateips/{privateip_id}</p>
|
|
<div class="p" id="vpc_privateip_0002__p15948192319554"><a href="#vpc_privateip_0002__table4378562">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="vpc_privateip_0002__table4378562"></a><a name="table4378562"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_privateip_0002__table4378562" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="vpc_privateip_0002__row14851049"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpc_privateip_0002__p62084314">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.2"><p id="vpc_privateip_0002__p62773503">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.3.2.2.4.1.3"><p id="vpc_privateip_0002__p51488960">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_privateip_0002__row9856263"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpc_privateip_0002__p60159801">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="vpc_privateip_0002__p41105728">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="vpc_privateip_0002__p10487112">Specifies the project ID. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_privateip_0002__row35522984"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpc_privateip_0002__p58789457">privateip_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="vpc_privateip_0002__p64325611">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="vpc_privateip_0002__p42992030">Specifies the ID of the private IP address, which uniquely identifies the private IP address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_privateip_0002__section5787686"><h4 class="sectiontitle">Request Parameters</h4><p id="vpc_privateip_0002__p5897927420428">None</p>
|
|
</div>
|
|
<div class="section" id="vpc_privateip_0002__section1710916019817"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="vpc_privateip_0002__screen20059395144856">GET https://{Endpoint}/v1/{project_id}/privateips/d600542a-b231-45ed-af05-e9930cb14f78</pre>
|
|
</div>
|
|
<div class="section" id="vpc_privateip_0002__section52089174"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpc_privateip_0002__table66473901155923" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter</caption><thead align="left"><tr id="vpc_privateip_0002__row7115943155923"><th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.5.2.2.4.1.1"><p id="vpc_privateip_0002__p39520483155923">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.5.2.2.4.1.2"><p id="vpc_privateip_0002__p52352674155923">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.15%" id="mcps1.3.5.2.2.4.1.3"><p id="vpc_privateip_0002__p12708212155923">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_privateip_0002__row22732275155923"><td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.5.2.2.4.1.1 "><p id="vpc_privateip_0002__p29374982155923">privateip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.5.2.2.4.1.2 "><p id="vpc_privateip_0002__p59712266155923"><a href="#vpc_privateip_0002__table23250319">privateip</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.15%" headers="mcps1.3.5.2.2.4.1.3 "><p id="vpc_privateip_0002__p43698339155923">Specifies the private IP address objects. For details, see <a href="#vpc_privateip_0002__table23250319">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpc_privateip_0002__table23250319"></a><a name="table23250319"></a><table cellpadding="4" cellspacing="0" summary="" id="vpc_privateip_0002__table23250319" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Description of the <strong id="vpc_privateip_0002__b84101850152912">privateip</strong> field</caption><thead align="left"><tr id="vpc_privateip_0002__row21723514"><th align="left" class="cellrowborder" valign="top" width="25.28%" id="mcps1.3.5.3.2.4.1.1"><p id="vpc_privateip_0002__p14774201">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.580000000000002%" id="mcps1.3.5.3.2.4.1.2"><p id="vpc_privateip_0002__p21721490173058">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.14%" id="mcps1.3.5.3.2.4.1.3"><p id="vpc_privateip_0002__p28338386">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpc_privateip_0002__row13707899"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_privateip_0002__p36597996">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_privateip_0002__p14610233173058">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.14%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_privateip_0002__ul13978236183119"><li id="vpc_privateip_0002__li18977036143113">Specifies the status of the private IP address.</li><li id="vpc_privateip_0002__li1464831917378">Possible values are as follows:<ul id="vpc_privateip_0002__ul948092312377"><li id="vpc_privateip_0002__li882113258373"><strong id="vpc_privateip_0002__b38501286192">ACTIVE</strong></li><li id="vpc_privateip_0002__li109781336143111"><strong id="vpc_privateip_0002__b775717296193">DOWN</strong></li></ul>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_privateip_0002__row53064224"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_privateip_0002__p3234911">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_privateip_0002__p42578245173058">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.14%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_privateip_0002__p47453675">Specifies the ID of the private IP address, which uniquely identifies the private IP address.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_privateip_0002__row36801206"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_privateip_0002__p28107703">subnet_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_privateip_0002__p26285854173058">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.14%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_privateip_0002__p26383427">Specifies the ID of the subnet from which IP addresses are assigned.</p>
|
|
<p id="vpc_privateip_0002__p9590171394616">If you use the management console, the value of this parameter is the <strong id="vpc_privateip_0002__vpc_subnet01_0002_b195522519461">Network ID</strong> value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_privateip_0002__row54031349181512"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_privateip_0002__p4774073181513">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_privateip_0002__p49967057181513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.14%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_privateip_0002__p167315119118">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_privateip_0002__row25113108"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_privateip_0002__p20895830">device_owner</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_privateip_0002__p48779435173058">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.14%" headers="mcps1.3.5.3.2.4.1.3 "><ul id="vpc_privateip_0002__ul1878734133215"><li id="vpc_privateip_0002__li17786143326">Specifies the resource using the private IP address. The parameter is left blank if it is not used.</li><li id="vpc_privateip_0002__li1477918321708">The value can be:<p id="vpc_privateip_0002__p10169439016"><a name="vpc_privateip_0002__li1477918321708"></a><a name="li1477918321708"></a><strong id="vpc_privateip_0002__b14922833112817">network:dhcp</strong>: DHCP service IP address</p>
|
|
<p id="vpc_privateip_0002__p9319114912010"><strong id="vpc_privateip_0002__b516232719316">network:router_interface_distributed</strong>: Gateway IP address</p>
|
|
<p id="vpc_privateip_0002__p13640135315014"><strong id="vpc_privateip_0002__b1561710249340">compute:</strong><em id="vpc_privateip_0002__i31822893419">xxx</em> (<em id="vpc_privateip_0002__i8356152115410">xxx</em> indicates the AZ name. For example, <strong id="vpc_privateip_0002__b15139182934119">compute:aa-bb-cc</strong> indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC</p>
|
|
<p id="vpc_privateip_0002__p1114618386019"><strong id="vpc_privateip_0002__b185025532441">neutron:VIP_PORT</strong>: Virtual IP address</p>
|
|
<p id="vpc_privateip_0002__p118874561018"><strong id="vpc_privateip_0002__b13903204615458">neutron:LOADBALANCERV2</strong>: IP address of a shared load balancer</p>
|
|
<p id="vpc_privateip_0002__p132486301410"><strong id="vpc_privateip_0002__b926314481472">neutron:LOADBALANCERV3</strong>: IP address of a dedicated load balancer</p>
|
|
<p id="vpc_privateip_0002__p31101816152"><strong id="vpc_privateip_0002__b11940171124817">network:endpoint_interface</strong>: IP address of a VPC endpoint</p>
|
|
<p id="vpc_privateip_0002__p1686083795918"><strong id="vpc_privateip_0002__b661815339816">network:nat_gateway</strong>: IP address used by a NAT gateway</p>
|
|
</li><li id="vpc_privateip_0002__li1578718443216">The value range specifies only the type of private IP addresses supported by the current service.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpc_privateip_0002__row46793790"><td class="cellrowborder" valign="top" width="25.28%" headers="mcps1.3.5.3.2.4.1.1 "><p id="vpc_privateip_0002__p32200631">ip_address</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.5.3.2.4.1.2 "><p id="vpc_privateip_0002__p58820181173058">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.14%" headers="mcps1.3.5.3.2.4.1.3 "><p id="vpc_privateip_0002__p19644001">Specifies the assigned private IP address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpc_privateip_0002__section102971113486"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="vpc_privateip_0002__screen25404421144843">{
|
|
"privateip":
|
|
{
|
|
"status": "DOWN",
|
|
"id": "d600542a-b231-45ed-af05-e9930cb14f78",
|
|
"subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd",
|
|
"tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
|
|
"device_owner": "",
|
|
"ip_address": "192.168.1.11"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="vpc_privateip_0002__section31981619"><h4 class="sectiontitle">Status Code</h4><p id="vpc_privateip_0002__p18112112662914">See <a href="vpc_api_0002.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="vpc_privateip_0002__section85821649202813"><h4 class="sectiontitle">Error Code</h4><p id="vpc_privateip_0002__p7233105282813">See <a href="vpc_api_0003.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpc_privateip_0000.html">Private IP Address</a></div>
|
|
</div>
|
|
</div>
|
|
|