vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/sfs/api-ref/ShowPermRule.html
zhangyue 49ac6fa9ce SFS HPC API DOC 
Reviewed-by: Miskanin, Jan <jan.miskanin@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-08-16 12:25:57 +00:00

247 lines
17 KiB
HTML
Raw Permalink Blame History

<a name="ShowPermRule"></a><a name="ShowPermRule"></a>
<h1 class="topictitle1">Querying a Permission Rule by ID</h1>
<div id="body105411958185815"><div class="section" id="ShowPermRule__section1854135818589"><h4 class="sectiontitle">Function</h4><p id="ShowPermRule__p2541105815814">This API is used to query a specific permission rule of a file system.</p>
</div>
<div class="section" id="ShowPermRule__section135411058135817"><h4 class="sectiontitle">URI</h4><p id="ShowPermRule__p16541155812587">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__table554218587581" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowPermRule__row4541758105813"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowPermRule__p175422584589">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowPermRule__p14542185855812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowPermRule__p1854265816580">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowPermRule__p15422058155817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPermRule__row9542105815819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowPermRule__p12542658115815">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowPermRule__p454235812580">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowPermRule__p354317582588">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowPermRule__p4543145815820">Project ID</p>
</td>
</tr>
<tr id="ShowPermRule__row8542115817583"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowPermRule__p19543185813587">share_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowPermRule__p2543195812587">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowPermRule__p65431758155810">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowPermRule__p3543115810584">File system ID</p>
</td>
</tr>
<tr id="ShowPermRule__row854213580584"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowPermRule__p12543185810581">rule_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowPermRule__p15543258185817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowPermRule__p2054345805820">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowPermRule__p354320588584">Permission rule ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowPermRule__section7543105805817"><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__row95442589583"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowPermRule__p1854445815810">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowPermRule__p1154465811582">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowPermRule__p1154485814589">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowPermRule__p15441658165814">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPermRule__row8544155819588"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowPermRule__p65441758165815">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowPermRule__p254495812585">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowPermRule__p15443583585">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowPermRule__p1054555813585">Account token</p>
</td>
</tr>
<tr id="ShowPermRule__row354455815589"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowPermRule__p18545195810588">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowPermRule__p1254518589587">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowPermRule__p1054535825814">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowPermRule__p6545458185811">MIME type</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowPermRule__section1054520586580"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowPermRule__p85451258105817"><strong id="ShowPermRule__b15545458125817">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__row65458588585"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowPermRule__p16546758135820">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowPermRule__p254612589588">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowPermRule__p1054695820581">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPermRule__row1454511584583"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowPermRule__p55465583580">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowPermRule__p1054625817585">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowPermRule__p5546165818585">Permission rule ID</p>
</td>
</tr>
<tr id="ShowPermRule__row6545558195812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowPermRule__p1254695820583">ip_cidr</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowPermRule__p954619589587">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowPermRule__p17546858105814">IP address or IP address range of the authorized object</p>
</td>
</tr>
<tr id="ShowPermRule__row5545858155820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowPermRule__p8547185885814">rw_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowPermRule__p1154710585584">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowPermRule__p75479581582">Read/write permission of the authorized object.</p>
<ul id="ShowPermRule__ul17547858155817"><li id="ShowPermRule__li1854765817588"><strong id="ShowPermRule__b554710589585">rw</strong>: read and write permission, which is the default option</li><li id="ShowPermRule__li4547125875817"><strong id="ShowPermRule__b2054725845818">ro</strong>: read-only permission</li><li id="ShowPermRule__li45473588587"><strong id="ShowPermRule__b1154710589587">none</strong>: no permission</li></ul>
</td>
</tr>
<tr id="ShowPermRule__row354505845812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowPermRule__p854717582581">user_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowPermRule__p5547758205813">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowPermRule__p8547195819580">File system access permission granted to the user of the authorized object. Supported values are:</p>
<ul id="ShowPermRule__ul85474586589"><li id="ShowPermRule__li2054745813581"><strong id="ShowPermRule__b654755814581">no_root_squash</strong>: allows the root user on the client to access the file system as <strong id="ShowPermRule__b16547135817587">root</strong>.</li><li id="ShowPermRule__li1854835819583"><strong id="ShowPermRule__b13548358185817">root_squash</strong>: allows the root user on the client to access the file system as <strong id="ShowPermRule__b1754855810588">nfsnobody</strong>.</li><li id="ShowPermRule__li1954845805815"><strong id="ShowPermRule__b3548155814581">all_squash</strong>: allows any user on the client to access the file system as <strong id="ShowPermRule__b3548165875819">nfsnobody</strong>. It is the default value.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowPermRule__p10548115885814"><strong id="ShowPermRule__b125481658105816">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__row1654885835813"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowPermRule__p15486585589">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowPermRule__p1454825817588">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowPermRule__p115481558175818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPermRule__row185481258195810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPermRule__p2549158135819">errCode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPermRule__p125491458165810">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPermRule__p85491958195820">Error code</p>
<p id="ShowPermRule__p65491458175820">Minimum: <strong id="ShowPermRule__b5549358195815">8</strong></p>
<p id="ShowPermRule__p1754995855813">Maximum: <strong id="ShowPermRule__b175492058175817">36</strong></p>
</td>
</tr>
<tr id="ShowPermRule__row1548165815583"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPermRule__p85491658135815">errMsg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPermRule__p2549105811586">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPermRule__p5549185835813">Error description</p>
<p id="ShowPermRule__p4549105895814">Minimum: <strong id="ShowPermRule__b18549125815817">2</strong></p>
<p id="ShowPermRule__p105491458115810">Maximum: <strong id="ShowPermRule__b11549185875820">512</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ShowPermRule__p1154925835810"><strong id="ShowPermRule__b15549135895816">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowPermRule__table3549175835811" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ShowPermRule__row954915865812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="ShowPermRule__p255035815815">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="ShowPermRule__p1550658175817">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="ShowPermRule__p45509585586">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPermRule__row7549155865818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowPermRule__p1550195816580">errCode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowPermRule__p25502058195813">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowPermRule__p6550158125819">Error code</p>
<p id="ShowPermRule__p1155014584589">Minimum: <strong id="ShowPermRule__b1655016587589">8</strong></p>
<p id="ShowPermRule__p3550658155818">Maximum: <strong id="ShowPermRule__b1355055845816">36</strong></p>
</td>
</tr>
<tr id="ShowPermRule__row12549185895810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowPermRule__p555016581582">errMsg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowPermRule__p17551175816580">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowPermRule__p145516582583">Error description</p>
<p id="ShowPermRule__p14551115895819">Minimum: <strong id="ShowPermRule__b12551658105814">2</strong></p>
<p id="ShowPermRule__p9551258145812">Maximum: <strong id="ShowPermRule__b185511458195815">512</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowPermRule__section1055116587584"><h4 class="sectiontitle">Example Requests</h4><p id="ShowPermRule__p1355114580583">Querying details about the permission rule whose ID is <strong id="ShowPermRule__b135511358135816">11abef677ac40f46644d1d5cfc2424a4</strong> for the file system whose ID is <strong id="ShowPermRule__b0551258135820">77ba6f4b-6365-4895-8dda-bc7142af4dde</strong></p>
<pre class="screen" id="ShowPermRule__screen7551458195814">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__section5551115875819"><h4 class="sectiontitle">Example Responses</h4><p id="ShowPermRule__p10551458145812"><strong id="ShowPermRule__b1455185816589">Status code: 200</strong></p>
<p id="ShowPermRule__p955185885819">Successful query</p>
<pre class="screen" id="ShowPermRule__screen14551145814584">{
"id" : "1131ed520xxxxxxebedb6e57xxxxxxxx",
"ip_cidr" : "192.168.0.0/16",
"rw_type" : "rw",
"user_type" : "no_root_squash"
}</pre>
<p id="ShowPermRule__p1055245835817"><strong id="ShowPermRule__b195521858165810">Status code: 400</strong></p>
<p id="ShowPermRule__p0552195812589">Error response</p>
<pre class="screen" id="ShowPermRule__screen6552558125820">{
"errCode" : "SFS.TURBO.0001",
"errMsg" : "Invalid rule id"
}</pre>
<p id="ShowPermRule__p165525585585"><strong id="ShowPermRule__b11552358195819">Status code: 500</strong></p>
<p id="ShowPermRule__p12552145810588">Error response</p>
<pre class="screen" id="ShowPermRule__screen1455317588587">{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "Internal server error"
}</pre>
</div>
<div class="section" id="ShowPermRule__section115531458115817"><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__row125535588585"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowPermRule__p3553145813586">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__p7553155845815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPermRule__row355311583582"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowPermRule__p6554135815815">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowPermRule__p12554558125811">Successful query</p>
</td>
</tr>
<tr id="ShowPermRule__row1155355816588"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowPermRule__p655416580582">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowPermRule__p185541258105814">Error response</p>
</td>
</tr>
<tr id="ShowPermRule__row655375865813"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowPermRule__p155485835817">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowPermRule__p25541258185810">Error response</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowPermRule__section175544581586"><h4 class="sectiontitle">Error Codes</h4><p id="ShowPermRule__p755412586582">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>
View Git Blame Copy Permalink