forked from docs/doc-exports
Wei, Hongmin
80f18fd272
Reviewed-by: Kabai, Zoltán Gábor <zoltan-gabor.kabai@t-systems.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
283 lines
25 KiB
HTML
283 lines
25 KiB
HTML
<a name="en-us_topic_0057845562"></a><a name="en-us_topic_0057845562"></a>
|
|
|
|
<h1 class="topictitle1">Querying Endpoints</h1>
|
|
<div id="body1492670576048"><div class="section" id="en-us_topic_0057845562__s81394c6441e2433aa089b83d9ae901bb"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0057845562__p1152514132414">This API is used to query the list of terminal addresses and provides a service access entry.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845562__s7f773a8bf34349f5bf81d0c7af9a440d"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0057845562__en-us_topic_0031136110_ul149855"><li id="en-us_topic_0057845562__en-us_topic_0031136110_li1348700">URI format<p id="en-us_topic_0057845562__p27552195172038"><a name="en-us_topic_0057845562__en-us_topic_0031136110_li1348700"></a><a name="en-us_topic_0031136110_li1348700"></a>GET /v3/endpoints{?interface, service_id}</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0057845562__u8dd71a3ddb964ad98b10deb904596d6b"><li id="en-us_topic_0057845562__lde934e37511f467faaf70452d7030d6f">URI parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845562__t3b91158605e2483f8ec0f7e76612766e" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845562__r7c9a4d7646cc40838d1c27ac6a0771ed"><th align="left" class="cellrowborder" valign="top" width="20.89%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0057845562__a870dd0e09c234313a6279943760cd249"><strong id="en-us_topic_0057845562__b37426530113629">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.89%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0057845562__a3fa42d29543146eda8cc5294eee7152c"><strong id="en-us_topic_0057845562__b842352706112524">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.759999999999998%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0057845562__a8747c43669bb409782410e7aafd0e8d9"><strong id="en-us_topic_0057845562__b84235270615026">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.46%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0057845562__a7f591587c22c4b1ebc7dedb7d0d2a0d6"><strong id="en-us_topic_0057845562__b14438018113629">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845562__rf333d691ffb44900a252228851b25489"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845562__ae5039ab3eff744ad907f616fc966800e">interface</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.89%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845562__en-us_topic_0031136110_p768020911147">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.759999999999998%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845562__a4f03dce88dca4b1db054686a2bb07d31">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845562__p1833035034212">Plane to which an endpoint belongs.</p>
|
|
<p id="en-us_topic_0057845562__ac5f8e279cf8b4f34bac2ed5df644fbf5">The value can be <strong id="en-us_topic_0057845562__b842352706195827">public</strong>, <strong id="en-us_topic_0057845562__b842352706195832">internal</strong>, or <strong id="en-us_topic_0057845562__b842352706195837">admin</strong>.</p>
|
|
<ul id="en-us_topic_0057845562__ul11999124617111"><li id="en-us_topic_0057845562__li139996466110"><strong id="en-us_topic_0057845562__b842352706195852">public</strong>: Users can view it on the public network interface.</li><li id="en-us_topic_0057845562__li119990469113"><strong id="en-us_topic_0057845562__b1791347348">internal</strong>: Users can view it on the internal network interface.</li><li id="en-us_topic_0057845562__li999974617119"><strong id="en-us_topic_0057845562__b8423527062002">admin</strong>: The administrator can view it on the secure network interface.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r9f23e5d0e8de4d70bb3200d16e4f2789"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0057845562__a8b74590de667463195f36260f5b8baf9">service_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.89%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0057845562__a2e615c570a484ad3bd1572d579904e5e">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.759999999999998%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0057845562__a2b5c563d5b934e40979aac7a0904045c">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0057845562__en-us_topic_0031136110_p529112711147">Service ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845562__sf86f3f4f84a8493e84f564c16c53eaf3"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0057845562__u7cd9a667c76d4333b6ac7e360a4a3443"><li id="en-us_topic_0057845562__l16936a689e304ddca247700dfa2665c2">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845562__tab13448d4b644cd482b72e023e311a4c" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845562__r9cc8c45e565f499a85068ccf812c4906"><th align="left" class="cellrowborder" valign="top" width="20.89%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0057845562__en-us_topic_0031136110_p289771511147"><strong id="en-us_topic_0057845562__b126291251">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.759999999999998%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0057845562__aa8a52be628254fb799e7d667253339cf"><strong id="en-us_topic_0057845562__b1136101692">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.89%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0057845562__a8de3dfc3143a4304a1273fade5a53dae"><strong id="en-us_topic_0057845562__b1072350687">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.46%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0057845562__a51fedaacfb0744a39c0e39893bf93f94"><strong id="en-us_topic_0057845562__b1145730962">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845562__r439e4c7cd1bc47f5a75d1632d4b0d739"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845562__a0131df71ca694a6ca73f9ad3a3a794a9">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.759999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845562__en-us_topic_0031136110_p746938611147">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.89%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845562__en-us_topic_0031136110_p104050011147">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845562__a15c772f0a23d4d52b8f64d1377e3410a">Fill <strong id="en-us_topic_0057845562__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r80e6b051a95142239d52ef85b3b9e59c"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845562__a88f9db0a7b6c4b4690378ccf5a787f60">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.759999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845562__ad6cfd0f57eb643a0afb40a639b4a8515">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.89%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845562__ac4cc17eda4bf4dd4aa34a5449be8f04e">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845562__a259cd575002145db850a7dcaf1cbe007">Authenticated token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845562__l72dc26377af9444c8ea21cdf9048b2d0">Example request<pre class="screen" id="en-us_topic_0057845562__s6b85ed1428f745fabd2d60e4481ee1db"><em id="en-us_topic_0057845562__i658774183711">curl -i -k -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -H "X-Auth-Token:$token" -X GET https://sample.domain.com/v3/endpoints?interface=public&service_id=43cbe5e77aaf4665bbb962062dc1fc9d</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845562__s6e8a35fa777c4de29b376bef459aba1d"><h4 class="sectiontitle">Response Parameters</h4><ul id="en-us_topic_0057845562__u97ea2b17d2d64e61ae9be0af5669e794"><li id="en-us_topic_0057845562__l7b47ed0e0ef24afdac252824488294e5">Parameters in the response body
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845562__t9b9cc7b83ce9466facb4897baefbd791" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845562__r6f8d72799e954178a1c13b2708d9c121"><th align="left" class="cellrowborder" valign="top" width="20.89%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0057845562__aadd4863bb2174e1c8719a4c40ab8dfd6"><strong id="en-us_topic_0057845562__b1537063315">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.89%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0057845562__a6f2fff27222d4aedad96357dac77ff93"><strong id="en-us_topic_0057845562__b61426966">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.63%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0057845562__a6083fcf4a1b748159753a8800608d241"><strong id="en-us_topic_0057845562__b1126072038">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.589999999999996%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0057845562__ae5d4ab162e88407f98ae462ff5f98fce"><strong id="en-us_topic_0057845562__b2002607533">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845562__r16afb2529a6341649de40ef7ff47933c"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845562__a72924dbd8aa54cda8ab55e77fcb56c30">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.89%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845562__a851dfd46f4794e7cad023dcf8504aae2">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845562__a9363b3ac19a04bab9f845375faaa318c">dict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.589999999999996%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845562__ae524881a658143949b0abea373ae6c4b">Endpoint resource link.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r192d669799e346b696708a75a8dae810"><td class="cellrowborder" valign="top" width="20.89%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0057845562__add0a344089f5407699a10789a24858fc">endpoints</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.89%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0057845562__a4782d8832a9b49e7a2f63f33fdf3c9f1">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0057845562__a3f160b835d4c46daa70430037fda9c82">list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.589999999999996%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0057845562__en-us_topic_0031136110_p203975521820">List of endpoints.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845562__li1017165620378">Description for the endpoints format
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845562__t16022c574b1f456a9e3297282854efaf" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845562__r4133e3880d0440b59b24410f7f89af5d"><th align="left" class="cellrowborder" valign="top" width="21.15%" id="mcps1.3.4.2.2.1.1.5.1.1"><p id="en-us_topic_0057845562__a7138bee2d8cc41199306dc41c55eb5e8"><strong id="en-us_topic_0057845562__b485907131">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.03%" id="mcps1.3.4.2.2.1.1.5.1.2"><p id="en-us_topic_0057845562__aa07bf7c32f024c11b532cad9df2bf50a"><strong id="en-us_topic_0057845562__b639634190">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.360000000000003%" id="mcps1.3.4.2.2.1.1.5.1.3"><p id="en-us_topic_0057845562__a1467c9fcdb724143b22fc72f0bfeae9a"><strong id="en-us_topic_0057845562__b1038419248">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.46%" id="mcps1.3.4.2.2.1.1.5.1.4"><p id="en-us_topic_0057845562__a9fcabcd69a75432fba32464cdaa09e49"><strong id="en-us_topic_0057845562__b1720994370">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845562__r15edfdd4c059495cb29238044439d202"><td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845562__a2971dbb1a1654dfe85ed54a8d90b22d7">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845562__a4170ff579cde4b15b4fbb694f35b3a8d">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845562__af6c77d268cea4449abb3a07fbfe3e64d">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845562__afd58bdac91854377841b4a27796e3d3a">Endpoint ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r77a90cc239f946aaa8b3216933dd7b62"><td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845562__aa251ba66310e45ff821ff8fca12d0284">url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845562__ae0fd727d9b6c41d4b89ddcac8ccc77da">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845562__a71143d726f8d4b43937c927aa3b78c12">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845562__a6e58b2fabc424cac9436270e40b8ffc8">Terminal endpoint URL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__rc5fb03f0f6aa4698abeb469bde3835a8"><td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845562__a79b6a077c4eb4d929cfefd18246d3f1e">region</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845562__ad5731f649ce24224854aa29ca4946b5e">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845562__a5d196fdb5fcd4808b2d7e544161bfbcb">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845562__a9c85283a25964b44883a0b6d22c6b2f4">Region to which an endpoint belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r2096cd2bc2eb4b8ca39e9fdad2c17abf"><td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845562__ad2dcf84f07cc41c38e900a5d90d06739">region_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845562__ab96b74713e05427c8439edb349ce487a">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845562__a075e9acc826c414f8888326b94d78aa7">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845562__a25e316b867d04d72a0a507269ef030bb">ID of the region to which an endpoint belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r4922ccdb2d08465b94962d83d5228584"><td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845562__a64d2d781d0d2410ead11072acb279bb6">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845562__a9a7be9e28d194926b1124c08af56e199">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845562__a049def9b6a2943378b78e42ad2eeceb1">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845562__a3064e8830a2043319d9079497d7eb003">Whether an endpoint is available.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r6344aee994a24051be58519d4c9cfb9e"><td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845562__a43498c3cf2104e84a79c19749889d933">interface</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845562__a0b3a5427e0db43cc99daa7176081c580">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845562__ac579d4c833b34b309dbad0e5e89f099c">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845562__a381f50159a6147319a9614014bd1f239">Plane to which an endpoint belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r9940352ff08f494091659e4c40ae85f1"><td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845562__a6a5ef091076949d8ae3d40e1fedd37e5">service_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845562__a372888c6e85e48e7876fe01b6240ae04">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845562__aa0bc2dc415544308b924a959dcebcff9">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845562__aba5234bd2cad42579cc42dd2bc9d9e5d">ID of the service to which an endpoint belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r1524ca29ae2241558138b4bd41f0c804"><td class="cellrowborder" valign="top" width="21.15%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="en-us_topic_0057845562__en-us_topic_0031136110_p719542217241">links</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="en-us_topic_0057845562__a233563f9d238407b9b6572e26d5dbdd6">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.360000000000003%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="en-us_topic_0057845562__a1fca8face8944d9c999fa0c684918e71">dict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.46%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="en-us_topic_0057845562__a5454237eb6554868a596bf506fa32964">Endpoint resource link.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0057845562__li1333375504219">Example response (successful request)<pre class="screen" id="en-us_topic_0057845562__screen2033316558428">{
|
|
"endpoints": [
|
|
{
|
|
"region_id": null,
|
|
"links": {
|
|
"self": "https://sample.domain.com/v3/endpoints/162277d696f54cf592f19b569f85d158"
|
|
},
|
|
"url": "https://sample.domain.com/v3",
|
|
"region": null,
|
|
"enabled": true,
|
|
"interface": "public",
|
|
"service_id": "053d21d488d1463c818132d9d08fb617",
|
|
"id": "162277d696f54cf592f19b569f85d158"
|
|
}
|
|
],
|
|
"links": {
|
|
"self": "https://sample.domain.com/v3/endpoints?service_id=053d21d488d1463c818132d9d08fb617&interface=public",
|
|
"previous": null,
|
|
"next": null
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0057845562__s161ee4f22c7a4e5f928bf049a4425742"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0057845562__en-us_topic_0031136110_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0057845562__en-us_topic_0031136110_row10578662"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0057845562__en-us_topic_0031136110_p51565323"><strong id="en-us_topic_0057845562__b37151362163018">Status Code</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.2"><p id="en-us_topic_0057845562__en-us_topic_0031136110_p16041657"><strong id="en-us_topic_0057845562__b38470707163018">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0057845562__en-us_topic_0031136110_row24305815"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845562__en-us_topic_0031136110_p22613965">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845562__en-us_topic_0031136110_p19791876">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__en-us_topic_0031136110_row43909159"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845562__en-us_topic_0031136110_p66980994">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845562__en-us_topic_0031136110_p56751409">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__re5868592b58a49148d1e374ab0ee4186"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845562__a67da088f332e48ca9c70f3ba30897dde">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845562__a0525ff08629b4648808d6e876aaf9c5f">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__en-us_topic_0031136110_row41000636"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845562__en-us_topic_0031136110_p32717189">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845562__a98f74bf5eda646c6a5973dfa742126c4">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r40e82c2469d34bf089fe9bfb0fa81526"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845562__a8be4e075b25144a38cbe0ff05c2b2f15">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845562__a5147e7c96ca94cb882828f2c4a33c1dc">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r6ae77ec5e12645e0a53aa0f3be73d1a9"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845562__a61cb90ae8ac1482f83a82028556bbee5">405</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845562__a41bd1c94c1ba4153b7346917bc58b6b3">The method specified in the request is not allowed for the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__rbea4e490c384410e8d1210ca41179e16"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845562__a9eaf1c04680e4901822818bfe53ee0fc">413</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845562__a5e2acac6d93f406caa8cb7f89f4b0e4d">The request entity is too large.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r3b34616283144b19899b01b4552b799c"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845562__a898bb41bdd874b25b452c9fd609e5bc0">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845562__ad43eae2906e84b6fb48fb6c11746dfab">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0057845562__r73ae10963ce24ea09cafcfec5f21c2ab"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0057845562__a3f2f513363a24dcb87462518dff622e7">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0057845562__a642a35bd05f24df68588a7f13c7cb3b7">Service unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0057845604.html">Services and Endpoints</a></div>
|
|
</div>
|
|
</div>
|
|
|