doc-exports/docs/swr/api-ref/swr_02_0029.html
Dong, Qiu Jian 150bc2026a SWR API initial version reuploaded -20221102
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
2022-11-10 10:18:36 +00:00

128 lines
8.8 KiB
HTML

<a name="swr_02_0029"></a><a name="swr_02_0029"></a>
<h1 class="topictitle1">Querying the Details of an Organization</h1>
<div id="body1531798197425"><div class="section" id="swr_02_0029__section14905762191056"><h4 class="sectiontitle">Function</h4><p id="swr_02_0029__p38546794191926">Query the details of an organization by its name.</p>
</div>
<div class="section" id="swr_02_0029__section10482810165331"><h4 class="sectiontitle">URI</h4><p id="swr_02_0029__p9609115118129">GET /v2/manage/namespaces/{<em id="swr_02_0029__i18154184710563">namespace</em>}</p>
<p id="swr_02_0029__p1160013561311">For details about parameters, see <a href="#swr_02_0029__table05962819187">Table 1</a>.</p>
<div class="tablenoborder"><a name="swr_02_0029__table05962819187"></a><a name="table05962819187"></a><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0029__table05962819187" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="swr_02_0029__row18599289181"><th align="left" class="cellrowborder" valign="top" width="20.03799620037996%" id="mcps1.3.2.4.2.5.1.1"><p id="swr_02_0029__p145942820183">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.97870212978702%" id="mcps1.3.2.4.2.5.1.2"><p id="swr_02_0029__p1311119571031">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.27827217278272%" id="mcps1.3.2.4.2.5.1.3"><p id="swr_02_0029__p14796031194218">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.7050294970503%" id="mcps1.3.2.4.2.5.1.4"><p id="swr_02_0029__p205910283185">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="swr_02_0029__row146018284188"><td class="cellrowborder" valign="top" width="20.03799620037996%" headers="mcps1.3.2.4.2.5.1.1 "><p id="swr_02_0029__p0601928131816">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="12.97870212978702%" headers="mcps1.3.2.4.2.5.1.2 "><p id="swr_02_0029__p1611814571310">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.27827217278272%" headers="mcps1.3.2.4.2.5.1.3 "><p id="swr_02_0029__p48011931194218">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.7050294970503%" headers="mcps1.3.2.4.2.5.1.4 "><p id="swr_02_0029__p7159145451713">Organization name</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="swr_02_0029__section3270966102931"><h4 class="sectiontitle">Request</h4><ul id="swr_02_0029__ul88701222192311"><li id="swr_02_0029__li128701422102316">Request parameters<p id="swr_02_0029__p1249318276239"><a name="swr_02_0029__li128701422102316"></a><a name="li128701422102316"></a>N/A</p>
</li><li id="swr_02_0029__li121201424192312">Example request<pre class="screen" id="swr_02_0029__screen5962203415238">GET https://{Endpoint}/v2/manage/namespaces/<em id="swr_02_0029__i1812525522813">group</em></pre>
</li></ul>
</div>
<div class="section" id="swr_02_0029__section46271297104114"><h4 class="sectiontitle">Response</h4><ul id="swr_02_0029__ul739815012260"><li id="swr_02_0029__li53981605262">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0029__table1787854911167" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameter description</caption><thead align="left"><tr id="swr_02_0029__row1588184916165"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="swr_02_0029__p158847496166">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="swr_02_0029__p2088624911169">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="swr_02_0029__p128875496169">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="swr_02_0029__row888994917169"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="swr_02_0029__p1889144915167">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="swr_02_0029__p189324913167">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="swr_02_0029__p14894149141612">Organization ID</p>
</td>
</tr>
<tr id="swr_02_0029__row19895649171616"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="swr_02_0029__p589616491166">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="swr_02_0029__p990115495162">String</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="swr_02_0029__p2904184981613">Organization name</p>
</td>
</tr>
<tr id="swr_02_0029__row1576047252"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="swr_02_0029__p3578164162517">creator_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="swr_02_0029__p8578134122515">String</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="swr_02_0029__p1557814492513">IAM username</p>
</td>
</tr>
<tr id="swr_02_0029__row670815227263"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="swr_02_0029__p270822232620">auth</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="swr_02_0029__p11708622162613">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="swr_02_0029__p3709822102615">User permission</p>
<ul id="swr_02_0029__ul1371263010195"><li id="swr_02_0029__li189653313198">7: Manage</li><li id="swr_02_0029__li35307340190">3: Write</li><li id="swr_02_0029__li127124307191">1: Read</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="swr_02_0029__li714192172616">Example response<pre class="screen" id="swr_02_0029__screen115699975811">{
"id": 1422,
"name": "group",
"creator_name": "username",
"auth": 7
}</pre>
</li></ul>
</div>
<div class="section" id="swr_02_0029__section5365169104253"><h4 class="sectiontitle">Status Code</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0029__t33d02fa79e8443868a71c99f411610a5" frame="border" border="1" rules="all"><thead align="left"><tr id="swr_02_0029__r9eb80d64e8f34d0db940daa95fc929dd"><th align="left" class="cellrowborder" valign="top" width="16.439999999999998%" id="mcps1.3.5.2.1.3.1.1"><p id="swr_02_0029__a7e51ed73a71e4dc29d0dd4aae3016632">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="83.56%" id="mcps1.3.5.2.1.3.1.2"><p id="swr_02_0029__aa802d02e21c944f1863435a0d11c7ec1">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="swr_02_0029__r1cc0192c651444db882dde750b14be23"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.5.2.1.3.1.1 "><p id="swr_02_0029__a6a3639a3cb154e17b95c5076c8036471">200</p>
</td>
<td class="cellrowborder" valign="top" width="83.56%" headers="mcps1.3.5.2.1.3.1.2 "><p id="swr_02_0029__ad54ae639e7f94380a87bfc10cc91a4f0">Query succeeded.</p>
</td>
</tr>
<tr id="swr_02_0029__r0bd68000afe546dd9c7a8d3a05991a04"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.5.2.1.3.1.1 "><p id="swr_02_0029__ad46ccdc6b7e04df3b6b5679f7606f434">400</p>
</td>
<td class="cellrowborder" valign="top" width="83.56%" headers="mcps1.3.5.2.1.3.1.2 "><p id="swr_02_0029__a1f2e8d58145d461781428d28f07a5351">Request error.</p>
</td>
</tr>
<tr id="swr_02_0029__row059261364320"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.5.2.1.3.1.1 "><p id="swr_02_0029__p059261310438">401</p>
</td>
<td class="cellrowborder" valign="top" width="83.56%" headers="mcps1.3.5.2.1.3.1.2 "><p id="swr_02_0029__p759261314433">Authentication failed.</p>
</td>
</tr>
<tr id="swr_02_0029__row9547111612437"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.5.2.1.3.1.1 "><p id="swr_02_0029__p19547131615432">404</p>
</td>
<td class="cellrowborder" valign="top" width="83.56%" headers="mcps1.3.5.2.1.3.1.2 "><p id="swr_02_0029__p16547416114315">The organization does not exist.</p>
</td>
</tr>
<tr id="swr_02_0029__r19bdef782c164c93917f897241e521f8"><td class="cellrowborder" valign="top" width="16.439999999999998%" headers="mcps1.3.5.2.1.3.1.1 "><p id="swr_02_0029__a7da68e311c0f4267bacf3cbdb71d1ead">500</p>
</td>
<td class="cellrowborder" valign="top" width="83.56%" headers="mcps1.3.5.2.1.3.1.2 "><p id="swr_02_0029__aa6fd12cedd8841e29eeeca27c1bdea1a">Internal error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="swr_02_0011.html">API</a></div>
</div>
</div>