forked from docs/doc-exports
zhangyue
e0d0a83c1f
Reviewed-by: Muller, Martin <martin.muller@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
239 lines
16 KiB
HTML
239 lines
16 KiB
HTML
<a name="ShowPermRule"></a><a name="ShowPermRule"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Permission Rule by ID</h1>
|
|
<div id="body1708331107508"><div class="section" id="ShowPermRule__section98951750507"><h4 class="sectiontitle">Function</h4><p id="ShowPermRule__p1489519500017">This API is used to query a specific permission rule of a file system.</p>
|
|
</div>
|
|
<div class="section" id="ShowPermRule__section18951650901"><h4 class="sectiontitle">URI</h4><p id="ShowPermRule__p689513501707">GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules/{rule_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowPermRule__table19896195015016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowPermRule__row18895150807"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowPermRule__p489616501909">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowPermRule__p10896105017020">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowPermRule__p589655017018">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowPermRule__p58961650907">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowPermRule__row98951850108"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowPermRule__p68968501403">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowPermRule__p208961501405">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowPermRule__p98973501509">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowPermRule__p2897205020013">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowPermRule__row168953506018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowPermRule__p10897950504">share_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowPermRule__p1189975013010">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowPermRule__p118996508013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowPermRule__p158998507010">File system ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowPermRule__row2895125019019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowPermRule__p18899750008">rule_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowPermRule__p19899550906">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowPermRule__p98999504017">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowPermRule__p1090045015018">Permission rule ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowPermRule__section6900550508"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowPermRule__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ShowPermRule__row89001750904"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowPermRule__p890011506010">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowPermRule__p1890005019013">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowPermRule__p1490145013015">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowPermRule__p15901105012017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowPermRule__row1990012506010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowPermRule__p69012500019">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowPermRule__p13901350808">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowPermRule__p1890115015011">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowPermRule__p1890115019015">Account token</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowPermRule__row1590011502010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowPermRule__p1890185018011">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowPermRule__p1390185017019">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowPermRule__p6901135013010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowPermRule__p1790114509010">MIME type</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowPermRule__section19014501208"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowPermRule__p890119501806"><strong id="ShowPermRule__b190216501304">Status code: 200</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowPermRule__response_OnePermRuleResponseInfo" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowPermRule__row9902145016010"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowPermRule__p890295016012">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowPermRule__p39023501401">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowPermRule__p18902950908">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowPermRule__row790218501207"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowPermRule__p159020501015">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowPermRule__p1690215013013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowPermRule__p8903155017015">Permission rule ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowPermRule__row790295012011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowPermRule__p79033506010">ip_cidr</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowPermRule__p59031750003">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowPermRule__p159034505010">IP address or IP address range of the authorized object</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowPermRule__row79029505014"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowPermRule__p16903350706">rw_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowPermRule__p11903155013014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowPermRule__p490314506019">Read/write permission of the authorized object.</p>
|
|
<ul id="ShowPermRule__ul139034501008"><li id="ShowPermRule__li89030501306"><strong id="ShowPermRule__b149032501407">rw</strong>: read and write permission, which is the default option</li><li id="ShowPermRule__li89032501507"><strong id="ShowPermRule__b89033507016">ro</strong>: read-only permission</li><li id="ShowPermRule__li1690335015020"><strong id="ShowPermRule__b109031450806">none</strong>: no permission</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowPermRule__row990285012015"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowPermRule__p14904750807">user_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowPermRule__p139044502007">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowPermRule__p9904135013016">File system access permission granted to the user of the authorized object. Supported values are:</p>
|
|
<ul id="ShowPermRule__ul1690485013017"><li id="ShowPermRule__li189041750700"><strong id="ShowPermRule__b1790405017016">no_root_squash</strong>: allows the root user on the client to access the file system as <strong id="ShowPermRule__b6904450807">root</strong>.</li><li id="ShowPermRule__li16904115016016"><strong id="ShowPermRule__b390415503010">root_squash</strong>: allows the root user on the client to access the file system as <strong id="ShowPermRule__b790455016013">nfsnobody</strong>.</li><li id="ShowPermRule__li1690418501900"><strong id="ShowPermRule__b7904185013012">all_squash</strong>: allows any user on the client to access the file system as <strong id="ShowPermRule__b19904135013018">nfsnobody</strong>. It is the default value.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowPermRule__p2090415017012"><strong id="ShowPermRule__b990415501200">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowPermRule__response_ErrorResp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ShowPermRule__row69043502017"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowPermRule__p189051450804">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowPermRule__p69051450404">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowPermRule__p390515501507">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowPermRule__row17904150405"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPermRule__p13905150906">errCode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPermRule__p89054505013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPermRule__p1090510502019">Error code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowPermRule__row99049501018"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPermRule__p129050502008">errMsg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPermRule__p590520504019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPermRule__p39057501016">Error description</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="ShowPermRule__p09055501104"><strong id="ShowPermRule__b159066503013">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowPermRule__table69068501805" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ShowPermRule__row1190665016010"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="ShowPermRule__p1390615507012">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="ShowPermRule__p19068502014">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="ShowPermRule__p1990611509018">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowPermRule__row69065501905"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowPermRule__p89061650609">errCode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowPermRule__p1190685011019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowPermRule__p1190685012014">Error code</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowPermRule__row159061504016"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowPermRule__p49073505013">errMsg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowPermRule__p1090765012014">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowPermRule__p17907250207">Error description</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowPermRule__section11907550808"><h4 class="sectiontitle">Example Requests</h4><p id="ShowPermRule__p890715501001">Querying details about the permission rule whose ID is <strong id="ShowPermRule__b1390715018015">11abef677ac40f46644d1d5cfc2424a4</strong> for the file system whose ID is <strong id="ShowPermRule__b19907650403">77ba6f4b-6365-4895-8dda-bc7142af4dde</strong></p>
|
|
<pre class="screen" id="ShowPermRule__screen890719506015">GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/fs/perm-rules/11abef677ac40f46644d1d5cfc2424a4</pre>
|
|
</div>
|
|
<div class="section" id="ShowPermRule__section1690714501306"><h4 class="sectiontitle">Example Responses</h4><p id="ShowPermRule__p12907350408"><strong id="ShowPermRule__b10907165011012">Status code: 200</strong></p>
|
|
<p id="ShowPermRule__p3907125019020">Successful query</p>
|
|
<pre class="screen" id="ShowPermRule__screen69071502016">{
|
|
"id" : "1131ed520xxxxxxebedb6e57xxxxxxxx",
|
|
"ip_cidr" : "192.168.xx.xx/16",
|
|
"rw_type" : "rw",
|
|
"user_type" : "no_root_squash"
|
|
}</pre>
|
|
<p id="ShowPermRule__p13908650906"><strong id="ShowPermRule__b490819508015">Status code: 400</strong></p>
|
|
<p id="ShowPermRule__p59081650702">Error response</p>
|
|
<pre class="screen" id="ShowPermRule__screen890885014019">{
|
|
"errCode" : "SFS.TURBO.0001",
|
|
"errMsg" : "Invalid rule id"
|
|
}</pre>
|
|
<p id="ShowPermRule__p1190813501709"><strong id="ShowPermRule__b09087507015">Status code: 500</strong></p>
|
|
<p id="ShowPermRule__p790813501302">Error response</p>
|
|
<pre class="screen" id="ShowPermRule__screen1090811509016">{
|
|
"errCode" : "SFS.TURBO.0005",
|
|
"errMsg" : "Internal server error"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ShowPermRule__section09091501005"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowPermRule__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowPermRule__row1590916501405"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowPermRule__p199096501308">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowPermRule__p17909175019017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ShowPermRule__row169091250308"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowPermRule__p17909165010011">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowPermRule__p16909175016020">Successful query</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowPermRule__row119091450109"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowPermRule__p11909450200">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowPermRule__p189091501901">Error response</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ShowPermRule__row1909250704"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowPermRule__p991017504015">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowPermRule__p39107505018">Error response</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ShowPermRule__section1691015012011"><h4 class="sectiontitle">Error Codes</h4><p id="ShowPermRule__p199101750002">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000007.html">Permissions Management</a></div>
|
|
</div>
|
|
</div>
|
|
|