Files
doc-exports/docs/sfs/api-ref/sfs_02_0117.html
zhangyue e0d0a83c1f SFS API DOC
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2025-04-14 12:20:07 +00:00

214 lines
14 KiB
HTML

<a name="sfs_02_0117"></a><a name="sfs_02_0117"></a>
<h1 class="topictitle1">Obtaining File System ACL Information</h1>
<div id="body0000001338755306"><div class="section" id="sfs_02_0117__section177945718522"><h4 class="sectiontitle">Function</h4><p id="sfs_02_0117__p1179527105212">This API is used to obtain the ACL information of a file system.</p>
</div>
<div class="section" id="sfs_02_0117__section19795177125214"><h4 class="sectiontitle">URI</h4><p id="sfs_02_0117__p2796170526">GET /</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0117__table179717115217" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Query parameter</caption><thead align="left"><tr id="sfs_02_0117__row1779615795210"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="sfs_02_0117__p879819716521">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="sfs_02_0117__p2079812712525">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="sfs_02_0117__p1179912710529">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="sfs_02_0117__p1179927185219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0117__row879710715521"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="sfs_02_0117__p1179915716524">sfsacl</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="sfs_02_0117__p14800197175217">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="sfs_02_0117__p5800187165219">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="sfs_02_0117__p16801177185219">/</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="sfs_02_0117__section118016710528"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0117__en-us_topic_0000001263111404_en-us_topic_0000001311159565_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="sfs_02_0117__row88021073528"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="sfs_02_0117__p10803127195219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="sfs_02_0117__p138041278521">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="sfs_02_0117__p78047716529">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="sfs_02_0117__p780517205218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0117__row1780210765214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="sfs_02_0117__p1805675526">Date</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="sfs_02_0117__p2805117205216">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="sfs_02_0117__p178065715220">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="sfs_02_0117__p1380647175212">The request time.</p>
</td>
</tr>
<tr id="sfs_02_0117__row180217165210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="sfs_02_0117__p380719785214">Authorization</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="sfs_02_0117__p168072765214">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="sfs_02_0117__p148079713523">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="sfs_02_0117__p8808167105212">The signature information.</p>
</td>
</tr>
<tr id="sfs_02_0117__row1880247155217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="sfs_02_0117__p380914795212">Host</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="sfs_02_0117__p208101676523">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="sfs_02_0117__p138108715215">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="sfs_02_0117__p58111673524">The host address.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="sfs_02_0117__section9811176522"><h4 class="sectiontitle">Response Parameters</h4><p id="sfs_02_0117__p98123735217"><strong id="sfs_02_0117__b13511126162611">Status code: 200</strong></p>
<div class="tablenoborder"><a name="sfs_02_0117__en-us_topic_0000001263111404_en-us_topic_0000001311159565_response_Statement"></a><a name="en-us_topic_0000001263111404_en-us_topic_0000001311159565_response_Statement"></a><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0117__en-us_topic_0000001263111404_en-us_topic_0000001311159565_response_Statement" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameter</caption><thead align="left"><tr id="sfs_02_0117__row138121577525"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="sfs_02_0117__p081317105215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="sfs_02_0117__p581410714527">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="sfs_02_0117__p18141176526">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0117__row1881210716524"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="sfs_02_0117__p981587115220">Statement</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="sfs_02_0117__p9815107185218">Array of <a href="#sfs_02_0117__en-us_topic_0000001263111404_en-us_topic_0000001311159565_response_Statement">Statement</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="sfs_02_0117__p881613785211">Unique identification</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0117__table15816107115217" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Statement</caption><thead align="left"><tr id="sfs_02_0117__row138174714525"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="sfs_02_0117__p1181815795218">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="sfs_02_0117__p3818127115213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="sfs_02_0117__p20819147105210">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0117__row08176710527"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="sfs_02_0117__p3819271521">Sid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="sfs_02_0117__p88201272523">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="sfs_02_0117__p68203714524">The statement ID.</p>
</td>
</tr>
<tr id="sfs_02_0117__row88179710528"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="sfs_02_0117__p188215735216">Action</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="sfs_02_0117__p08214795216">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="sfs_02_0117__p168221475523">The allowed statement action.</p>
<p id="sfs_02_0117__p1882218719527">Enumerated values:</p>
<ul id="sfs_02_0117__ul382317714529"><li id="sfs_02_0117__li1882317155220"><strong id="sfs_02_0117__b158418472710">FullControl</strong>: read/write</li><li id="sfs_02_0117__li1082447195211"><strong id="sfs_02_0117__b989776192716">Read</strong>: read-only</li></ul>
</td>
</tr>
<tr id="sfs_02_0117__row178171976529"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="sfs_02_0117__p128261370522">Effect</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="sfs_02_0117__p1182712705220">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="sfs_02_0117__p16827274526">The effect specifying that the statement permission is <strong id="sfs_02_0117__b11706179172720">Allow</strong>.</p>
<p id="sfs_02_0117__p1682711765212">Enumerated value:</p>
<ul id="sfs_02_0117__ul1782887195217"><li id="sfs_02_0117__li28283713526"><strong id="sfs_02_0117__b08290712520">Allow</strong></li></ul>
</td>
</tr>
<tr id="sfs_02_0117__row8817177155213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="sfs_02_0117__p782937185216">Condition</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="sfs_02_0117__p1883012725218"><a href="#sfs_02_0117__en-us_topic_0000001263111404_en-us_topic_0000001311159565_response_Condition">Condition</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="sfs_02_0117__p108305719523">The conditions for a statement to take effect.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="sfs_02_0117__en-us_topic_0000001263111404_en-us_topic_0000001311159565_response_Condition"></a><a name="en-us_topic_0000001263111404_en-us_topic_0000001311159565_response_Condition"></a><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0117__en-us_topic_0000001263111404_en-us_topic_0000001311159565_response_Condition" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Condition</caption><thead align="left"><tr id="sfs_02_0117__row88312712525"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="sfs_02_0117__p1383213795217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="sfs_02_0117__p48338715526">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="sfs_02_0117__p183357145210">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0117__row783187155214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="sfs_02_0117__p138341876527">SourceVpc</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="sfs_02_0117__p1483413712522">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="sfs_02_0117__p128358712527">A specified VPC ID.</p>
</td>
</tr>
<tr id="sfs_02_0117__row98318745216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="sfs_02_0117__p78358775215">VpcSourceIp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="sfs_02_0117__p1383557165214">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="sfs_02_0117__p1083614711528">A specified IP address or IP address range. This parameter is currently not supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="sfs_02_0117__section1183610710527"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="sfs_02_0117__screen145982613246">GET /?sfsacl HTTP/1.1
Host: example-sfs-01.sfs3.example.region.com:443
Date: Wed, 07 Jun 2023 03:31:46 GMT
Authorization: OBS FNEX1B77SXDIB3TFMSZZ:eUqPlHnPDWGDTlgyLmsALA86wys=</pre>
</div>
<div class="section" id="sfs_02_0117__section683717710523"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="sfs_02_0117__screen163291129113715">HTTP/1.1 200 OK
Server: OBS
Content-Type: application/json
Content-Length: 131
Date: Wed, 07 Jun 2023 03:31:59 GMT
X-Obs-Request-Id: 0000018893E94B65C046B527778F8F14
X-Obs-Id-2: 32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSc2lEdSHcA04319WknB1DD5BdBKuGr1
{
"Statement": [
{
"Condition": {
"SourceVpc": "f85adabc-a387-4d1d-94cf-65ef9034f752"
},
"Action": "FullControl",
"Effect": "Allow",
"Sid": ""
}
]
}</pre>
</div>
<div class="section" id="sfs_02_0117__section10838187185219"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0117__en-us_topic_0000001263111404_en-us_topic_0000001311159565_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0117__row383927125219"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="sfs_02_0117__p1383917714527">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="sfs_02_0117__p1584007135216">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0117__row5839187195217"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="sfs_02_0117__p1184012785215">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="sfs_02_0117__p88411376526">The file system ACL is obtained.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="sfs_02_0117__section984177175215"><h4 class="sectiontitle">Error Codes</h4><p id="sfs_02_0117__p1284113714528">See <a href="sfs_02_0119.html">General Purpose File System Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="sfs_02_0115.html">File System Access Rules</a></div>
</div>
</div>