doc-exports/docs/iam/api-ref/en-us_topic_0067148045.html
zhangyue 3b5a58b1fe IAM API 2.0.38
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2022-10-26 04:31:24 +00:00

144 lines
12 KiB
HTML

<a name="en-us_topic_0067148045"></a><a name="en-us_topic_0067148045"></a>
<h1 class="topictitle1">Querying Service Details</h1>
<div id="body1500449320399"><div class="section" id="en-us_topic_0067148045__s1fea94fc86654d20a4264b290de6701b"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0067148045__p53616262416">This API is used to query service details.</p>
</div>
<div class="section" id="en-us_topic_0067148045__sd0c6621b74af445d8e95f2e8c5061c96"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0067148045__en-us_topic_0035544336_ul149855"><li id="en-us_topic_0067148045__en-us_topic_0035544336_li1348700">URI format<p id="en-us_topic_0067148045__p60548132171948"><a name="en-us_topic_0067148045__en-us_topic_0035544336_li1348700"></a><a name="en-us_topic_0035544336_li1348700"></a>GET /v3/services/{service_id}</p>
</li></ul>
<ul id="en-us_topic_0067148045__uccaabbdcaa0249adaae71204b5cc0483"><li id="en-us_topic_0067148045__l6799a9ff6f8f427a96b4b2444d2fa67a">URI parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148045__ta5ea92914f7e42ff96cb722ca62bbbc9" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148045__r4b24ae277ca941128fbc303aeaf8326a"><th align="left" class="cellrowborder" valign="top" width="20.75%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="en-us_topic_0067148045__af8e60b99318f4a20b2d78b90100c964d"><strong id="en-us_topic_0067148045__a173ae121cc9e48328ca613e72f2a1504">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.099999999999998%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="en-us_topic_0067148045__a3e2b7330b740417881fc8195c5dc3d24"><strong id="en-us_topic_0067148045__ac429376f11ae472b87ff4be326afb9d8_1">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.63%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="en-us_topic_0067148045__a181496d4ddc847339375b4f23dfc9987"><strong id="en-us_topic_0067148045__b842352706143526_1">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.52%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="en-us_topic_0067148045__a5e29560192784650a29a305b9bad99e5"><strong id="en-us_topic_0067148045__b20601766145329">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0067148045__r6af57967c5d04d67b0035d0ca833ad57"><td class="cellrowborder" valign="top" width="20.75%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="en-us_topic_0067148045__a50c523360f4d4908b875d10a28623c70">service_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.099999999999998%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="en-us_topic_0067148045__ac24e8e998166421f94f7530c61d06715">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="en-us_topic_0067148045__a87c50dfba8bc4d549c30e53012306af5">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.52%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="en-us_topic_0067148045__a5e8ec1f1ea9349f8a0219d77303769ef">Service ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0067148045__sc6a67a265e0c4e6c85c6dddbfffeec05"><h4 class="sectiontitle">Request Parameters</h4><ul id="en-us_topic_0067148045__u1d3947ed86684f15b247b7f85ff13e49"><li id="en-us_topic_0067148045__l6d0e380a90d345d1a6fc4da81b881634">Parameters in the request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148045__t97020ff6a99b4d02897c62dc32176b10" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148045__r33f9811ab31441bcbb68da4318582ff7"><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_0067148045__a15b20b8a2b1a4846942c4381d69d0f1f"><strong id="en-us_topic_0067148045__b21588442152010">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.23%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="en-us_topic_0067148045__a0c341246324648c2a331a2f3b29728ce"><strong id="en-us_topic_0067148045__ac429376f11ae472b87ff4be326afb9d8_3">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.63%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="en-us_topic_0067148045__ae3c49c667f304a8ea41ef4821a55dd34"><strong id="en-us_topic_0067148045__b842352706143526_3">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="42.65%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="en-us_topic_0067148045__ac65744bcbe944be4891ed74be82742a6"><strong id="en-us_topic_0067148045__b4059516152010">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0067148045__rd59aad8dd3584169840a2a50ca0bc035"><td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0067148045__a5f8f06a2f0f141d1b14d88d3cec03e26">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0067148045__a0c8ab11defdf4c8f817b21b21680e919">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0067148045__a222d884836b34d4b96111de13ad02311">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.65%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0067148045__af58e489f66734ee8bfea4223431362ec">Fill <strong id="en-us_topic_0067148045__b842352706161331">application/json;charset=utf8</strong> in this field.</p>
</td>
</tr>
<tr id="en-us_topic_0067148045__red29555edeb84300a63e22cdf504909a"><td class="cellrowborder" valign="top" width="20.49%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="en-us_topic_0067148045__a41b44a08aca64e4382a1901f5c4d384d">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="en-us_topic_0067148045__a554d5f30caf14006ba608ee5e933804c">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.63%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="en-us_topic_0067148045__aa734bd6d2ee44712b9b1fba893b1ea79">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.65%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="en-us_topic_0067148045__a3598b3c82d4745f18c1f204cf8097e6d">Authenticated token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="en-us_topic_0067148045__l203797174d05411c8b00a37fc553402c">Example request<pre class="screen" id="en-us_topic_0067148045__s8023a0f3e27d49229da33bb33babebc3"><em id="en-us_topic_0067148045__i45521226183716">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/services/5a4ed456d228428c800ed2b67b4363a7</em></pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0067148045__s6166214bb04d407290d8691550229884"><h4 class="sectiontitle">Response Parameters</h4><div class="p" id="en-us_topic_0067148045__p6481330162816">Example response (successful response)<pre class="screen" id="en-us_topic_0067148045__screen118181648174111">{
"service": {
"enabled": true,
"type": "compute",
"name": "nova",
"links": {
"self": "sample.domain.com/v3/services/5a4ed456d228428c800ed2b67b4363a7"
},
"id": "5a4ed456d228428c800ed2b67b4363a7"
}
}</pre>
</div>
</div>
<div class="section" id="en-us_topic_0067148045__se70eb4ec1a7c43ec9858561956f0a7ba"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0067148045__en-us_topic_0035544336_table25927028" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0067148045__en-us_topic_0035544336_row10578662"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.3.1.1"><p id="en-us_topic_0067148045__en-us_topic_0035544336_p51565323"><strong id="en-us_topic_0067148045__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_0067148045__en-us_topic_0035544336_p16041657"><strong id="en-us_topic_0067148045__b38470707163018">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0067148045__en-us_topic_0035544336_row24305815"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148045__en-us_topic_0035544336_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_0067148045__en-us_topic_0035544336_p19791876">The request is successful.</p>
</td>
</tr>
<tr id="en-us_topic_0067148045__en-us_topic_0035544336_row43909159"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148045__en-us_topic_0035544336_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_0067148045__en-us_topic_0035544336_p56751409">The server failed to process the request.</p>
</td>
</tr>
<tr id="en-us_topic_0067148045__rb99fbab78bc54ae4953661763b573830"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148045__aef55745ff0834933af36d690e2e339b8">401</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148045__a480215738ced4bf5a8feafa2681db93b">Authentication failed.</p>
</td>
</tr>
<tr id="en-us_topic_0067148045__en-us_topic_0035544336_row41000636"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148045__en-us_topic_0035544336_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_0067148045__ae678037f26d640f5a985c943e2ffb92e">Access denied.</p>
</td>
</tr>
<tr id="en-us_topic_0067148045__r1fd5c05b7b6b4c048f3f7b9ddbc755b0"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148045__a5d7e2305922e4f9098442a900792dae1">404</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148045__a9edf299d0513460caaac8a2a19b76e9a">The requested resource cannot be found.</p>
</td>
</tr>
<tr id="en-us_topic_0067148045__rbb5133f150fd42eebde8dd6e390ecbd5"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148045__ad1a2754016e44193a97043265cd611cf">405</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148045__a81837d461ef445259c5a6e9e1ce0e32a">The method specified in the request is not allowed for the requested resource.</p>
</td>
</tr>
<tr id="en-us_topic_0067148045__r2cecff297b1a412f956a312d3cd7acc9"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148045__a1f617621d1bc4a9facb1c84d1946002b">413</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148045__ac31ead3ee2db40eea8ae45b2779a09e9">The request entity is too large.</p>
</td>
</tr>
<tr id="en-us_topic_0067148045__rd71e0e00759f4179a2dccaf345ba9f2f"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148045__a1657c5ca5ebd4a2cbacbdb35fc9b7601">500</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148045__a88b4b14048564e12942b8151dc791b99">Internal server error.</p>
</td>
</tr>
<tr id="en-us_topic_0067148045__r5647e5fd26974514ac66cc3925f30601"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.1 "><p id="en-us_topic_0067148045__a16dfaa16ceac4a33a468c0ae158292fb">503</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.3.1.2 "><p id="en-us_topic_0067148045__a5635c1924d9648a8be89b1e5dcf0a87b">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>