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>
120 lines
8.3 KiB
HTML
120 lines
8.3 KiB
HTML
<a name="iam_02_0004"></a><a name="iam_02_0004"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Service Catalog</h1>
|
|
<div id="body1520903548311"><div class="section" id="iam_02_0004__s81394c6441e2433aa089b83d9ae901bb"><h4 class="sectiontitle">Function</h4><p id="iam_02_0004__a598664aad454438e954e52788540ca06">This API is used to query the service catalog corresponding to <strong id="iam_02_0004__b842352706194752">X-Auth-Token</strong> contained in the request.</p>
|
|
</div>
|
|
<div class="section" id="iam_02_0004__s7f773a8bf34349f5bf81d0c7af9a440d"><h4 class="sectiontitle">URI</h4><p id="iam_02_0004__p27552195172038">GET /v3/auth/catalog</p>
|
|
</div>
|
|
<div class="section" id="iam_02_0004__sf86f3f4f84a8493e84f564c16c53eaf3"><h4 class="sectiontitle">Request Parameters</h4><ul id="iam_02_0004__u7cd9a667c76d4333b6ac7e360a4a3443"><li id="iam_02_0004__l16936a689e304ddca247700dfa2665c2">Parameters in the request header
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0004__tab13448d4b644cd482b72e023e311a4c" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0004__r9cc8c45e565f499a85068ccf812c4906"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="iam_02_0004__en-us_topic_0031136110_p289771511147"><strong id="iam_02_0004__b37426530113629">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="iam_02_0004__aa8a52be628254fb799e7d667253339cf"><strong id="iam_02_0004__ac429376f11ae472b87ff4be326afb9d8">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="iam_02_0004__a8de3dfc3143a4304a1273fade5a53dae"><strong id="iam_02_0004__b842352706143526_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="iam_02_0004__a51fedaacfb0744a39c0e39893bf93f94"><strong id="iam_02_0004__b14438018113629">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_02_0004__r80e6b051a95142239d52ef85b3b9e59c"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="iam_02_0004__a88f9db0a7b6c4b4690378ccf5a787f60">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="iam_02_0004__ad6cfd0f57eb643a0afb40a639b4a8515">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="iam_02_0004__ac4cc17eda4bf4dd4aa34a5449be8f04e">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="iam_02_0004__a259cd575002145db850a7dcaf1cbe007">Authenticated scoped token of a project.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="iam_02_0004__l72dc26377af9444c8ea21cdf9048b2d0">Example request<pre class="screen" id="iam_02_0004__screen35344880155047">curl -i -k -H 'Accept:application/json' -H 'X-Auth-Token:$token' -H 'Content-Type:application/json;charset=utf8' -X GET https://sample.domain.com/v3/auth/catalog</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="iam_02_0004__s6e8a35fa777c4de29b376bef459aba1d"><h4 class="sectiontitle">Response Parameters</h4><div class="p" id="iam_02_0004__p1097251232911">Example response (successful request)<pre class="screen" id="iam_02_0004__screen31858593155313">{
|
|
"catalog": [
|
|
{
|
|
"endpoints": [
|
|
{
|
|
"region_id": null,
|
|
"url": "https://sample.domain.com/v2/c972a59e958e407e89b0c6d8e522df3b",
|
|
"region": null,
|
|
"interface": "public",
|
|
"id": "04f0ee42038447f0a9c7b407028fd7b9"
|
|
}
|
|
],
|
|
"type": "compute",
|
|
"id": "eb884e9f64b44dd0ac73cdc55d817286",
|
|
"name": "nova"
|
|
}
|
|
],
|
|
"links": {
|
|
"self": "https://sample.domain.com/v3/auth/catalog"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="iam_02_0004__s161ee4f22c7a4e5f928bf049a4425742"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="iam_02_0004__en-us_topic_0031136110_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="iam_02_0004__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="iam_02_0004__en-us_topic_0031136110_p51565323"><strong id="iam_02_0004__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="iam_02_0004__en-us_topic_0031136110_p16041657"><strong id="iam_02_0004__b38470707163018">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="iam_02_0004__en-us_topic_0031136110_row24305815"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0004__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="iam_02_0004__en-us_topic_0031136110_p19791876">The request is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0004__en-us_topic_0031136110_row43909159"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0004__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="iam_02_0004__en-us_topic_0031136110_p56751409">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0004__re5868592b58a49148d1e374ab0ee4186"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0004__a67da088f332e48ca9c70f3ba30897dde">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0004__a0525ff08629b4648808d6e876aaf9c5f">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0004__en-us_topic_0031136110_row41000636"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0004__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="iam_02_0004__a98f74bf5eda646c6a5973dfa742126c4">Access denied.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0004__r40e82c2469d34bf089fe9bfb0fa81526"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0004__a8be4e075b25144a38cbe0ff05c2b2f15">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0004__a5147e7c96ca94cb882828f2c4a33c1dc">The requested resource cannot be found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0004__r6ae77ec5e12645e0a53aa0f3be73d1a9"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0004__a61cb90ae8ac1482f83a82028556bbee5">405</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0004__a41bd1c94c1ba4153b7346917bc58b6b3">The method specified in the request is not allowed for the requested resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0004__rbea4e490c384410e8d1210ca41179e16"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0004__a9eaf1c04680e4901822818bfe53ee0fc">413</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0004__a5e2acac6d93f406caa8cb7f89f4b0e4d">The request entity is too large.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0004__r3b34616283144b19899b01b4552b799c"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0004__a898bb41bdd874b25b452c9fd609e5bc0">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0004__ad43eae2906e84b6fb48fb6c11746dfab">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="iam_02_0004__r73ae10963ce24ea09cafcfec5f21c2ab"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="iam_02_0004__a3f2f513363a24dcb87462518dff622e7">503</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="iam_02_0004__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>
|
|
|