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>
147 lines
12 KiB
HTML
147 lines
12 KiB
HTML
<a name="en-us_topic_0067148046"></a><a name="en-us_topic_0067148046"></a>
|
|
|
|
<h1 class="topictitle1">Querying Endpoint Details</h1>
|
|
<div id="body1500449320401"><div class="section" id="en-us_topic_0067148046__s81394c6441e2433aa089b83d9ae901bb"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0067148046__p1122320214246">This API is used to query endpoint details.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0067148046__s7f773a8bf34349f5bf81d0c7af9a440d"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0067148046__en-us_topic_0031136110_ul149855"><li id="en-us_topic_0067148046__en-us_topic_0031136110_li1348700">URI format<p id="en-us_topic_0067148046__p27552195172038"><a name="en-us_topic_0067148046__en-us_topic_0031136110_li1348700"></a><a name="en-us_topic_0031136110_li1348700"></a>GET /v3/endpoints/{endpoint_id}</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0067148046__u8dd71a3ddb964ad98b10deb904596d6b"><li id="en-us_topic_0067148046__lde934e37511f467faaf70452d7030d6f">URI parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148046__t3b91158605e2483f8ec0f7e76612766e" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148046__r7c9a4d7646cc40838d1c27ac6a0771ed"><th align="left" class="cellrowborder" valign="top" width="20.747925207479252%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0067148046__a870dd0e09c234313a6279943760cd249"><strong id="en-us_topic_0067148046__a173ae121cc9e48328ca613e72f2a1504">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.428057194280573%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0067148046__a3fa42d29543146eda8cc5294eee7152c"><strong id="en-us_topic_0067148046__ac429376f11ae472b87ff4be326afb9d8">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.41785821417858%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0067148046__a8747c43669bb409782410e7aafd0e8d9"><strong id="en-us_topic_0067148046__b842352706143526_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="38.406159384061596%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0067148046__a7f591587c22c4b1ebc7dedb7d0d2a0d6"><strong id="en-us_topic_0067148046__b20601766145329">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0067148046__r9f23e5d0e8de4d70bb3200d16e4f2789"><td class="cellrowborder" valign="top" width="20.747925207479252%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0067148046__a8b74590de667463195f36260f5b8baf9">endpoint_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.428057194280573%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0067148046__a2e615c570a484ad3bd1572d579904e5e">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.41785821417858%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0067148046__a2b5c563d5b934e40979aac7a0904045c">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.406159384061596%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0067148046__en-us_topic_0031136110_p529112711147">Endpoint ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0067148046__sf86f3f4f84a8493e84f564c16c53eaf3"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0067148046__u7cd9a667c76d4333b6ac7e360a4a3443"><li id="en-us_topic_0067148046__l16936a689e304ddca247700dfa2665c2">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148046__tab13448d4b644cd482b72e023e311a4c" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148046__r9cc8c45e565f499a85068ccf812c4906"><th align="left" class="cellrowborder" valign="top" width="20.49%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="en-us_topic_0067148046__en-us_topic_0031136110_p289771511147"><strong id="en-us_topic_0067148046__b37426530113629">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.689999999999998%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0067148046__aa8a52be628254fb799e7d667253339cf"><strong id="en-us_topic_0067148046__b340076015">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.279999999999998%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0067148046__a8de3dfc3143a4304a1273fade5a53dae"><strong id="en-us_topic_0067148046__b842352706143526_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="38.54%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0067148046__a51fedaacfb0744a39c0e39893bf93f94"><strong id="en-us_topic_0067148046__b14438018113629">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0067148046__r439e4c7cd1bc47f5a75d1632d4b0d739"><td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0067148046__a0131df71ca694a6ca73f9ad3a3a794a9">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.689999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0067148046__en-us_topic_0031136110_p746938611147">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.279999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0067148046__en-us_topic_0031136110_p104050011147">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.54%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0067148046__a15c772f0a23d4d52b8f64d1377e3410a">Fill <strong id="en-us_topic_0067148046__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148046__r80e6b051a95142239d52ef85b3b9e59c"><td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0067148046__a88f9db0a7b6c4b4690378ccf5a787f60">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.689999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0067148046__ad6cfd0f57eb643a0afb40a639b4a8515">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.279999999999998%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0067148046__ac4cc17eda4bf4dd4aa34a5449be8f04e">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="38.54%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0067148046__a259cd575002145db850a7dcaf1cbe007">Authenticated token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0067148046__l72dc26377af9444c8ea21cdf9048b2d0">Example request<pre class="screen" id="en-us_topic_0067148046__s6b85ed1428f745fabd2d60e4481ee1db"><em id="en-us_topic_0067148046__i129111653811">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/62ea3602f8ee42b1825956473f5295a8</em></pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0067148046__s6e8a35fa777c4de29b376bef459aba1d"><h4 class="sectiontitle">Response Parameters</h4><div class="p" id="en-us_topic_0067148046__p155809016291"> Example response (successful request)<pre class="screen" id="en-us_topic_0067148046__screen2033316558428">{
|
|
"endpoint": {
|
|
"region_id": "<em id="en-us_topic_0067148046__i57391877102616">region_id</em>",
|
|
"links": {
|
|
"self": "<em id="en-us_topic_0067148046__i195141514115616">https://sample.domain.com</em>/v3/endpoints/62ea3602f8ee42b1825956473f5295a8"
|
|
},
|
|
"url": "https://sample.domain.com/v2/",
|
|
"region": "<em id="en-us_topic_0067148046__i5684482710266">region_name</em>",
|
|
"enabled": true,
|
|
"interface": "public",
|
|
"service_id": "5a4ed456d228428c800ed2b67b4363a7",
|
|
"id": "62ea3602f8ee42b1825956473f5295a8"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0067148046__s161ee4f22c7a4e5f928bf049a4425742"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148046__en-us_topic_0031136110_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148046__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_0067148046__en-us_topic_0031136110_p51565323"><strong id="en-us_topic_0067148046__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_0067148046__en-us_topic_0031136110_p16041657"><strong id="en-us_topic_0067148046__b38470707163018">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0067148046__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_0067148046__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_0067148046__en-us_topic_0031136110_p19791876">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148046__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_0067148046__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_0067148046__en-us_topic_0031136110_p56751409">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148046__re5868592b58a49148d1e374ab0ee4186"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148046__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_0067148046__a0525ff08629b4648808d6e876aaf9c5f">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148046__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_0067148046__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_0067148046__a98f74bf5eda646c6a5973dfa742126c4">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148046__r40e82c2469d34bf089fe9bfb0fa81526"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148046__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_0067148046__a5147e7c96ca94cb882828f2c4a33c1dc">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148046__r6ae77ec5e12645e0a53aa0f3be73d1a9"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148046__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_0067148046__a41bd1c94c1ba4153b7346917bc58b6b3">The method specified in the request is not allowed for the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148046__rbea4e490c384410e8d1210ca41179e16"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148046__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_0067148046__a5e2acac6d93f406caa8cb7f89f4b0e4d">The request entity is too large.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148046__r3b34616283144b19899b01b4552b799c"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148046__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_0067148046__ad43eae2906e84b6fb48fb6c11746dfab">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0067148046__r73ae10963ce24ea09cafcfec5f21c2ab"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148046__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_0067148046__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>
|
|
|