forked from docs/doc-exports
qiujiandong1
73ffc816f4
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com> Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com> Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
166 lines
14 KiB
HTML
166 lines
14 KiB
HTML
<a name="swr_02_0029"></a><a name="swr_02_0029"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About an Organization</h1>
|
|
<div id="body8662426"><div class="section" id="swr_02_0029__en-us_topic_0000001186074232_section147112523548"><h4 class="sectiontitle">Description</h4><p id="swr_02_0029__en-us_topic_0000001186074232_p77111152145419">Query the details about an organization.</p>
|
|
</div>
|
|
<div class="section" id="swr_02_0029__en-us_topic_0000001186074232_section14711165219544"><h4 class="sectiontitle">Constraints</h4><p id="swr_02_0029__en-us_topic_0000001186074232_p471115524544">None</p>
|
|
</div>
|
|
<div class="section" id="swr_02_0029__en-us_topic_0000001186074232_section13711195213545"><h4 class="sectiontitle">URI</h4><p id="swr_02_0029__en-us_topic_0000001186074232_p1671165285414">GET /v2/manage/namespaces/{namespace}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0029__en-us_topic_0000001186074232_table3711952135419" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameter</caption><thead align="left"><tr id="swr_02_0029__en-us_topic_0000001186074232_row9711165265417"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="swr_02_0029__en-us_topic_0000001186074232_p771212529543">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="swr_02_0029__en-us_topic_0000001186074232_p117122052175415">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="swr_02_0029__en-us_topic_0000001186074232_p16712165275414">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="swr_02_0029__en-us_topic_0000001186074232_p1671245210546">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0029__en-us_topic_0000001186074232_row19711852125417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="swr_02_0029__en-us_topic_0000001186074232_p19712135215412">namespace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="swr_02_0029__en-us_topic_0000001186074232_p1971255255419">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="swr_02_0029__en-us_topic_0000001186074232_p57127522543">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="swr_02_0029__en-us_topic_0000001186074232_p1371225213549">Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0029__en-us_topic_0000001186074232_section15712105285413"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0029__en-us_topic_0000001186074232_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="swr_02_0029__en-us_topic_0000001186074232_row0712185218542"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="swr_02_0029__en-us_topic_0000001186074232_p1371335275415">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="swr_02_0029__en-us_topic_0000001186074232_p771365215415">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="swr_02_0029__en-us_topic_0000001186074232_p37137522547">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="swr_02_0029__en-us_topic_0000001186074232_p12713105215542">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0029__en-us_topic_0000001186074232_row17712452135417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="swr_02_0029__en-us_topic_0000001186074232_p1671317529548">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="swr_02_0029__en-us_topic_0000001186074232_p37135524548">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="swr_02_0029__en-us_topic_0000001186074232_p771355210548">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="swr_02_0029__en-us_topic_0000001186074232_p12713152115416">Message body type (format). The value can be <strong id="swr_02_0029__en-us_topic_0000001186074232_b116111934165016">application/json</strong> or <strong id="swr_02_0029__en-us_topic_0000001186074232_b4611183415017">charset=utf-8 application/json</strong>.</p>
|
|
<p id="swr_02_0029__en-us_topic_0000001186074232_p107131552115417">Default value: <strong id="swr_02_0029__en-us_topic_0000001186074232_b7187439125014">application/json</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0029__en-us_topic_0000001186074232_row2712352125415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="swr_02_0029__en-us_topic_0000001186074232_p77133525543">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="swr_02_0029__en-us_topic_0000001186074232_p971411529549">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="swr_02_0029__en-us_topic_0000001186074232_p117141521544">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="swr_02_0029__en-us_topic_0000001186074232_p2071419521546">User token.</p>
|
|
<p id="swr_02_0029__en-us_topic_0000001186074232_p871418522546">The token can be obtained by calling an IAM API. The value of <strong id="swr_02_0029__en-us_topic_0000001186074232_b36755011502">X-Subject-Token</strong> in the response header is the user token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0029__en-us_topic_0000001186074232_section1671485218544"><h4 class="sectiontitle">Response Parameters</h4><p id="swr_02_0029__en-us_topic_0000001186074232_p10714452145418"><strong id="swr_02_0029__en-us_topic_0000001186074232_b1927652318111021">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0029__en-us_topic_0000001186074232_response_ShowNamespace" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="swr_02_0029__en-us_topic_0000001186074232_row671425205412"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="swr_02_0029__en-us_topic_0000001186074232_p1715175295410">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.2"><p id="swr_02_0029__en-us_topic_0000001186074232_p157159529545">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.3.2.4.1.3"><p id="swr_02_0029__en-us_topic_0000001186074232_p57151252135418">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0029__en-us_topic_0000001186074232_row27146525547"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="swr_02_0029__en-us_topic_0000001186074232_p771505219542">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="swr_02_0029__en-us_topic_0000001186074232_p4715252175417">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="swr_02_0029__en-us_topic_0000001186074232_p9715252125412">id</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0029__en-us_topic_0000001186074232_row1371405205420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="swr_02_0029__en-us_topic_0000001186074232_p1771545205410">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="swr_02_0029__en-us_topic_0000001186074232_p57151752115410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="swr_02_0029__en-us_topic_0000001186074232_p8715205212549">Organization name. Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0029__en-us_topic_0000001186074232_row16714145255410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="swr_02_0029__en-us_topic_0000001186074232_p2715135215541">creator_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="swr_02_0029__en-us_topic_0000001186074232_p7715195210544">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="swr_02_0029__en-us_topic_0000001186074232_p127151852165413">IAM username.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0029__en-us_topic_0000001186074232_row37145526543"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="swr_02_0029__en-us_topic_0000001186074232_p571525216542">auth</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.2 "><p id="swr_02_0029__en-us_topic_0000001186074232_p1371535213545">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.3.2.4.1.3 "><p id="swr_02_0029__en-us_topic_0000001186074232_p11715152155415">User permissions. <strong id="swr_02_0029__en-us_topic_0000001186074232_b2310113710361">7</strong>: manage. <strong id="swr_02_0029__en-us_topic_0000001186074232_b15310103714361">3</strong>: edit. <strong id="swr_02_0029__en-us_topic_0000001186074232_b831023723619">1</strong>: read.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0029__en-us_topic_0000001186074232_section187161652145412"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="swr_02_0029__en-us_topic_0000001186074232_screen371620527546">GET https://{endpoint}/v2/manage/namespaces/{namespace}</pre>
|
|
</div>
|
|
<div class="section" id="swr_02_0029__en-us_topic_0000001186074232_section97163529542"><h4 class="sectiontitle">Example Response</h4><p id="swr_02_0029__en-us_topic_0000001186074232_p47163525544"><strong id="swr_02_0029__en-us_topic_0000001186074232_b1150507972111021">Status code: 200</strong></p>
|
|
<p id="swr_02_0029__en-us_topic_0000001186074232_p11716952145420">Query succeeded.</p>
|
|
<pre class="screen" id="swr_02_0029__en-us_topic_0000001186074232_screen57161052125413">{
|
|
"id" : 1422,
|
|
"name" : "demo",
|
|
"creator_name" : "lgp",
|
|
"auth" : 7
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="swr_02_0029__en-us_topic_0000001186074232_section1471615205412"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="swr_02_0029__en-us_topic_0000001186074232_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="swr_02_0029__en-us_topic_0000001186074232_row13716652105417"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="swr_02_0029__en-us_topic_0000001186074232_p7717125213545">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="swr_02_0029__en-us_topic_0000001186074232_p471713520544">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="swr_02_0029__en-us_topic_0000001186074232_row1071665245416"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="swr_02_0029__en-us_topic_0000001186074232_p18717175265415">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="swr_02_0029__en-us_topic_0000001186074232_p37171352195417">Query succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0029__en-us_topic_0000001186074232_row5716185255414"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="swr_02_0029__en-us_topic_0000001186074232_p5717552145411">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="swr_02_0029__en-us_topic_0000001186074232_p671718526548">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0029__en-us_topic_0000001186074232_row20716155216541"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="swr_02_0029__en-us_topic_0000001186074232_p571745235416">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="swr_02_0029__en-us_topic_0000001186074232_p3717135211540">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0029__en-us_topic_0000001186074232_row17716552185412"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="swr_02_0029__en-us_topic_0000001186074232_p117171552145410">404</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="swr_02_0029__en-us_topic_0000001186074232_p11717552135412">Organization not found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="swr_02_0029__en-us_topic_0000001186074232_row7716125214549"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="swr_02_0029__en-us_topic_0000001186074232_p97171052115417">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="swr_02_0029__en-us_topic_0000001186074232_p171705255415">Internal error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="swr_02_0029__en-us_topic_0000001186074232_section1271765215543"><h4 class="sectiontitle">Error Codes</h4><p id="swr_02_0029__en-us_topic_0000001186074232_p5717155215415">For details, see <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="swr_02_0025.html">Organization Management</a></div>
|
|
</div>
|
|
</div>
|
|
|