vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/sfs/api-ref/en-us_topic_0000001614397248.html
zhangyue 8d1d100b18 SFS API DOC 
Reviewed-by: Miskanin, Jan <jan.miskanin@t-systems.com>
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-09-05 08:16:37 +00:00

228 lines
17 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001614397248"></a><a name="EN-US_TOPIC_0000001614397248"></a>
<h1 class="topictitle1">Querying Permission Rules of a File System</h1>
<div id="body0000001614397248"><div class="section" id="EN-US_TOPIC_0000001614397248__section558mcpsimp"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001614397248__p560mcpsimp">This API is used to query the permission rules of a file system.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001614397248__section565mcpsimp"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001614397248__p567mcpsimp">GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001614397248__table568mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001614397248__row576mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="EN-US_TOPIC_0000001614397248__p578mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="EN-US_TOPIC_0000001614397248__p580mcpsimp">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="EN-US_TOPIC_0000001614397248__p582mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="EN-US_TOPIC_0000001614397248__p584mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001614397248__row586mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001614397248__p588mcpsimp">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001614397248__p590mcpsimp">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001614397248__p592mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001614397248__p594mcpsimp">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001614397248__row595mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001614397248__p597mcpsimp">share_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001614397248__p599mcpsimp">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001614397248__p601mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001614397248__p603mcpsimp">File system ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001614397248__section604mcpsimp"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001614397248__table606mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001614397248__row614mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001614397248__p616mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001614397248__p618mcpsimp">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001614397248__p620mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001614397248__p622mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001614397248__row624mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001614397248__p626mcpsimp">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001614397248__p628mcpsimp">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001614397248__p630mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001614397248__p632mcpsimp">Account token</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001614397248__row633mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001614397248__p635mcpsimp">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001614397248__p637mcpsimp">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001614397248__p639mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001614397248__p641mcpsimp">MIME type</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001614397248__section642mcpsimp"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000001614397248__p644mcpsimp"><strong id="EN-US_TOPIC_0000001614397248__b84191625162314">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001614397248__table646mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameter</caption><thead align="left"><tr id="EN-US_TOPIC_0000001614397248__row653mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0000001614397248__p655mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0000001614397248__p657mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0000001614397248__p659mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001614397248__row661mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001614397248__p663mcpsimp">rules</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001614397248__p665mcpsimp">Array of <a href="#EN-US_TOPIC_0000001614397248___d0e19955">Table 4</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001614397248__p668mcpsimp">Permission rule information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001614397248__row112676359394"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001614397248__p52679354394">count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001614397248__p926710351397">int</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001614397248__p142671635183913">Total rules</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001614397248___d0e19955"></a><a name="_d0e19955"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001614397248___d0e19955" frame="border" border="1" rules="all"><caption><b>Table 4 </b>OnePermRuleResponseInfo</caption><thead align="left"><tr id="EN-US_TOPIC_0000001614397248__row675mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="EN-US_TOPIC_0000001614397248__p677mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="EN-US_TOPIC_0000001614397248__p679mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="EN-US_TOPIC_0000001614397248__p681mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001614397248__row683mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001614397248__p685mcpsimp">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001614397248__p687mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001614397248__p689mcpsimp">Permission rule ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001614397248__row690mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001614397248__p692mcpsimp">ip_cidr</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001614397248__p694mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001614397248__p696mcpsimp">IP address or IP address range of the authorized object</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001614397248__row697mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001614397248__p699mcpsimp">rw_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001614397248__p701mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001614397248__p703mcpsimp">Read/write permission of the authorized object. The value can be <strong id="EN-US_TOPIC_0000001614397248__b224445710365">rw</strong> (read and write permission), <strong id="EN-US_TOPIC_0000001614397248__b02461457123620">ro</strong> (read only permission), or <strong id="EN-US_TOPIC_0000001614397248__b0247125719362">none</strong> (no access permission). The default value is <strong id="EN-US_TOPIC_0000001614397248__b162471557183612">rw</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001614397248__row704mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001614397248__p706mcpsimp">user_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001614397248__p708mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001614397248__p710mcpsimp">File system access permission granted to the user of the authorized object. The value can be <strong id="EN-US_TOPIC_0000001614397248__b128411820102519">no_root_squash</strong>, <strong id="EN-US_TOPIC_0000001614397248__b15841122015252">root_squash</strong>, or <strong id="EN-US_TOPIC_0000001614397248__b1984282012513">all_squash</strong>. Value <strong id="EN-US_TOPIC_0000001614397248__b185371722122511">no_root_squash</strong> allows the root user on the client to access the file system as <strong id="EN-US_TOPIC_0000001614397248__b95386228255">root</strong>. Value <strong id="EN-US_TOPIC_0000001614397248__b19327124122515">root_squash</strong> allows the root user on the client to access the file system as <strong id="EN-US_TOPIC_0000001614397248__b1732714244252">nfsnobody</strong>. Value <strong id="EN-US_TOPIC_0000001614397248__b14753734172511">all_squash</strong> allows any user on the client to access the file system as <strong id="EN-US_TOPIC_0000001614397248__b775503472516">nfsnobody</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0000001614397248__p711mcpsimp"><strong id="EN-US_TOPIC_0000001614397248__b12801036192517">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001614397248__table713mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001614397248__row720mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="EN-US_TOPIC_0000001614397248__p722mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="EN-US_TOPIC_0000001614397248__p724mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="EN-US_TOPIC_0000001614397248__p726mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001614397248__row728mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001614397248__p730mcpsimp">errCode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001614397248__p732mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001614397248__p734mcpsimp">Error code</p>
<p id="EN-US_TOPIC_0000001614397248__p735mcpsimp">Minimum length: 8 characters</p>
<p id="EN-US_TOPIC_0000001614397248__p737mcpsimp">Maximum length: 36 characters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001614397248__row739mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="EN-US_TOPIC_0000001614397248__p741mcpsimp">errMsg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="EN-US_TOPIC_0000001614397248__p743mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="EN-US_TOPIC_0000001614397248__p745mcpsimp">Error message</p>
<p id="EN-US_TOPIC_0000001614397248__p746mcpsimp">Minimum length: 2 characters</p>
<p id="EN-US_TOPIC_0000001614397248__p748mcpsimp">Maximum length: 512 characters</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001614397248__section750mcpsimp"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0000001614397248__p752mcpsimp">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001614397248__section753mcpsimp"><h4 class="sectiontitle">Example Response</h4><p id="EN-US_TOPIC_0000001614397248__p755mcpsimp"><strong id="EN-US_TOPIC_0000001614397248__b9559119132612">Status code: 200</strong></p>
<div class="p" id="EN-US_TOPIC_0000001614397248__p757mcpsimp">Successful query<pre class="screen" id="EN-US_TOPIC_0000001614397248__screen758mcpsimp">{
"rules": [
{
"id": "2be0cc3d-cf1e-49d5-bce3-83e91e32ff42",
"ip_cidr": "*",
"rw_type": "rw",
"user_type": "no_root_squash"
},
{
"id": "d56a5130-6744-4a64-866b-9dc259f5a64c",
"ip_cidr": "188.88.88.88",
"rw_type": "ro",
"user_type": "no_root_squash"
}
],
"count": 2
}</pre>
</div>
<p id="EN-US_TOPIC_0000001614397248__p759mcpsimp"><strong id="EN-US_TOPIC_0000001614397248__b4237323112615">Status code: 500</strong></p>
<p id="EN-US_TOPIC_0000001614397248__p761mcpsimp">Error response</p>
<pre class="screen" id="EN-US_TOPIC_0000001614397248__screen762mcpsimp">{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "Internal server error"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001614397248__section763mcpsimp"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001614397248__table765mcpsimp" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001614397248__row770mcpsimp"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="EN-US_TOPIC_0000001614397248__p772mcpsimp">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="EN-US_TOPIC_0000001614397248__p774mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001614397248__row776mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001614397248__p778mcpsimp">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001614397248__p780mcpsimp">Successful query</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001614397248__row781mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001614397248__p783mcpsimp">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001614397248__p785mcpsimp">Error response</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0000001663116961.html">Permissions Management</a></div>
</div>
</div>
View Git Blame Copy Permalink