forked from docs/doc-exports
Qin Ying, Fan
ef5d2cd3cf
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>
138 lines
12 KiB
HTML
138 lines
12 KiB
HTML
<a name="vpcep_06_0302"></a><a name="vpcep_06_0302"></a>
|
|
|
|
<h1 class="topictitle1">Querying Basic Information About a VPC Endpoint Service</h1>
|
|
<div id="body20293844"><div class="section" id="vpcep_06_0302__section29800032"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="vpcep_06_0302__p33188676">This API is used to query basic information about a target VPC endpoint service. You can use this API to query the target VPC endpoint service to be accessed. This API can also be used by other users to query basic information about your VPC endpoint service, without exposing your server information.</p>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0302__section66873698"><h4 class="sectiontitle">URI</h4><p class="msonormal" id="vpcep_06_0302__p35353947">GET /v1/{project_id}/vpc-endpoint-services/describe?endpoint_service_name={endpoint_service_name}&id={endpoint_service_id}</p>
|
|
<div class="msonormal" id="vpcep_06_0302__p624413203159"><a href="#vpcep_06_0302__table19259243">Table 1</a> describes the parameter in this URI.
|
|
<div class="tablenoborder"><a name="vpcep_06_0302__table19259243"></a><a name="table19259243"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0302__table19259243" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="vpcep_06_0302__row55868958"><th align="left" class="cellrowborder" valign="top" width="28.999999999999996%" id="mcps1.3.2.3.2.2.4.1.1"><p id="vpcep_06_0302__p29091726"><strong id="vpcep_06_0302__b87145213519">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.2.3.2.2.4.1.2"><p id="vpcep_06_0302__p7619615"><strong id="vpcep_06_0302__b1019813256516">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41%" id="mcps1.3.2.3.2.2.4.1.3"><p id="vpcep_06_0302__p13209080"><strong id="vpcep_06_0302__b145216267515">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0302__row63302594"><td class="cellrowborder" valign="top" width="28.999999999999996%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="vpcep_06_0302__p27236517">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="vpcep_06_0302__p58674248">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="vpcep_06_0302__p54993619">Specifies the project ID. For details about how to obtain the project ID, see <a href="vpcep_08_0003.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="vpcep_06_0302__table16494874"></a><a name="table16494874"></a><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0302__table16494874" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="vpcep_06_0302__row60344611"><th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.2.4.2.5.1.1"><p id="vpcep_06_0302__p56075332"><strong id="vpcep_06_0302__b2363133813519">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="vpcep_06_0302__p45808045"><strong id="vpcep_06_0302__b946051757">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.4.2.5.1.3"><p id="vpcep_06_0302__p04912812293"><strong id="vpcep_06_0302__b10280928868">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="37%" id="mcps1.3.2.4.2.5.1.4"><p id="vpcep_06_0302__p19464199"><strong id="vpcep_06_0302__b1657681844">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0302__row33096314"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0302__p63555757">endpoint_service_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0302__p47742664">No</p>
|
|
<div class="note" id="vpcep_06_0302__note20155193717514"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0302__p215517374511">Either this parameter or the <strong id="vpcep_06_0302__b17561151485814">id</strong> parameter must be selected.</p>
|
|
</div></div>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0302__p349168152917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0302__p41950580">Specifies the name of the VPC endpoint service.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0302__row42010904"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.4.2.5.1.1 "><p id="vpcep_06_0302__p47440031">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="vpcep_06_0302__p17437323">No</p>
|
|
<div class="note" id="vpcep_06_0302__note97636123717"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="vpcep_06_0302__p4763141212711">Either this parameter or the <strong id="vpcep_06_0302__b9151174495816">endpoint_service_name</strong> parameter must be selected.</p>
|
|
</div></div>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.4.2.5.1.3 "><p id="vpcep_06_0302__p249113872912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.2.4.2.5.1.4 "><p id="vpcep_06_0302__p5301108164415">Specifies the unique ID of the VPC endpoint service.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0302__section64992378"><h4 class="sectiontitle">Request</h4><ul id="vpcep_06_0302__ul1313415474206"><li class="msonormal" id="vpcep_06_0302__li41346477207">Parameter description<p id="vpcep_06_0302__p218311157361"><a name="vpcep_06_0302__li41346477207"></a><a name="li41346477207"></a>None</p>
|
|
</li><li id="vpcep_06_0302__li189061227201719"><a name="vpcep_06_0302__li189061227201719"></a><a name="li189061227201719"></a>Example request<pre class="codeblock" id="vpcep_06_0302__codeblock10345194717522">GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/describe?id=4189d3c2-8882-4871-a3c2-d380272eed83</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="vpcep_06_0302__section29891285"><h4 class="sectiontitle">Response</h4><ul id="vpcep_06_0302__ul694531515214"><li class="msonormal" id="vpcep_06_0302__li794516153217">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="vpcep_06_0302__table14236141" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="vpcep_06_0302__row33026327"><th align="left" class="cellrowborder" valign="top" width="24.242424242424242%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="vpcep_06_0302__p57886792"><strong id="vpcep_06_0302__b354513337">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.292929292929294%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="vpcep_06_0302__p58318570"><strong id="vpcep_06_0302__b785336086">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="46.464646464646464%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="vpcep_06_0302__p26183716"><strong id="vpcep_06_0302__b2086970401">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="vpcep_06_0302__row40506271"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0302__p59782531">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.292929292929294%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0302__p10546806">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.464646464646464%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0302__p48984995">Specifies the unique ID of the VPC endpoint service.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0302__row38211774"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0302__p8145970">service_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.292929292929294%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0302__p55843827">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.464646464646464%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0302__p27056104">Specifies the name of the VPC endpoint service.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0302__row42178345"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0302__p61002824">service_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.292929292929294%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0302__p42281744">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.464646464646464%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0302__p135911520141219">Specifies the type of the VPC endpoint service. Only your private services can be configured into interface VPC endpoint services.</p>
|
|
<ul id="vpcep_06_0302__ul649612552553"><li id="vpcep_06_0302__vpcep_06_0201_li10401049390">Gateway: VPC endpoint services of this type are configured by operations people. You can use them directly without the need to create one by yourselves.</li><li id="vpcep_06_0302__vpcep_06_0201_li1664631084019">Interface: VPC endpoint services of this type include cloud services configured by operations people and private services created by yourselves. You cannot configure these cloud services, but can use them.</li></ul>
|
|
<p id="vpcep_06_0302__p941115410718">You can perform the operations in <a href="vpcep_06_0303.html">Creating a VPC Endpoint</a> to create VPC endpoints for accessing VPC endpoints of the gateway and interface types.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0302__row20423017"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0302__p43651709">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.292929292929294%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0302__p46127541">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.464646464646464%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0302__p22890001">Specifies the creation time of the VPC endpoint service.</p>
|
|
<p id="vpcep_06_0302__p871616113394">The UTC time format is used: YYYY-MM-DDTHH:MM:SSZ.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="vpcep_06_0302__row389811654114"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="vpcep_06_0302__p2089991612413">is_charge</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.292929292929294%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="vpcep_06_0302__p68996168416">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="46.464646464646464%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="vpcep_06_0302__p1389951614111">Specifies whether the associated VPC endpoint carries a charge.</p>
|
|
<ul id="vpcep_06_0302__ul4942193713444"><li id="vpcep_06_0302__vpcep_06_0301_li18942937174412"><strong id="vpcep_06_0302__vpcep_06_0301_b19200830195415">true</strong>: indicates that the associated VPC endpoint carries a charge.</li><li id="vpcep_06_0302__vpcep_06_0301_li19396242194417"><strong id="vpcep_06_0302__vpcep_06_0301_b950713385556">false</strong>: indicates that the associated VPC endpoint does not a charge.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="vpcep_06_0302__ul37744207"><li id="vpcep_06_0302__li4153545">Example response<pre class="screen" id="vpcep_06_0302__screen37381906">{
|
|
"id": "<em id="vpcep_06_0302__i16193134761415">9d4c1028-1336-4556-9881-b5d807c1b8a8</em>",
|
|
"service_name": "<em id="vpcep_06_0302__i1881435071415">test123</em>",
|
|
"service_type": "<em id="vpcep_06_0302__i1964305316147">interface</em>",
|
|
"created_at": "<em id="vpcep_06_0302__i14418578147">2018-09-17T07:28:31Z</em>",
|
|
"is_charge": "true"
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="vpcep_06_0302__section5275033"><h4 class="sectiontitle">Status Codes</h4><p class="msonormal" id="vpcep_06_0302__p46897145">See <a href="vpcep_08_0001.html">Status Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="vpcep_06_0200.html">APIs for Managing VPC Endpoint Services</a></div>
|
|
</div>
|
|
</div>
|
|
|