doc-exports/docs/obs/api-ref/obs_04_0090.html
zhangyue d5b1108742 OBS API DOC
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-10-16 12:27:49 +00:00

253 lines
18 KiB
HTML

<a name="obs_04_0090"></a><a name="obs_04_0090"></a>
<h1 class="topictitle1">Obtaining Object ACL Configuration</h1>
<div id="body54755590"><div class="section" id="obs_04_0090__section5584184924715"><h4 class="sectiontitle">Functions</h4><p id="obs_04_0090__p35810237">The implementation of this operation returns the ACL configuration of an object. You can perform this operation to view the ACL of an object, as long as you have the read permission for the object ACL.</p>
</div>
<div class="section" id="obs_04_0090__section53856681"><h4 class="sectiontitle">Versioning</h4><p id="obs_04_0090__p6017800">By default, this operation obtains the ACL of the latest version of an object. If the object has a delete marker, status code 404 is returned. To obtain the ACL of a specified version, the <strong id="obs_04_0090__b1392320102213">versionId</strong> parameter can be used to specify the desired version.</p>
</div>
<div class="section" id="obs_04_0090__section14948084"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0090__screen17773610151219"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span>GET<span class="w"> </span>/ObjectName?acl<span class="w"> </span>HTTP/1.1<span class="w"> </span>
Host:<span class="w"> </span>bucketname.obs.region.example.com
Date:<span class="w"> </span>date
Authorization:<span class="w"> </span>authorization
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0090__section315031"><h4 class="sectiontitle">Request Parameters</h4><p id="obs_04_0090__p41804449">The request parameter specifies the object ACL to be obtained. For details about the parameters, see <a href="#obs_04_0090__table22962068">Table 1</a>.</p>
<div class="tablenoborder"><a name="obs_04_0090__table22962068"></a><a name="table22962068"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0090__table22962068" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="obs_04_0090__row51500263"><th align="left" class="cellrowborder" valign="top" width="24.240000000000002%" id="mcps1.3.4.3.2.4.1.1"><p id="obs_04_0090__p10771806">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.4.3.2.4.1.2"><p id="obs_04_0090__p909510">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.18%" id="mcps1.3.4.3.2.4.1.3"><p id="obs_04_0090__p59053163">Mandatory</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0090__row19160315"><td class="cellrowborder" valign="top" width="24.240000000000002%" headers="mcps1.3.4.3.2.4.1.1 "><p id="obs_04_0090__p8481687">versionId</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.4.3.2.4.1.2 "><p id="obs_04_0090__p15928043">Version number of an object.</p>
<p id="obs_04_0090__p9134666">Type: string</p>
</td>
<td class="cellrowborder" valign="top" width="18.18%" headers="mcps1.3.4.3.2.4.1.3 "><p id="obs_04_0090__p1710502">No</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0090__section2835283"><h4 class="sectiontitle">Request Headers</h4><p id="obs_04_0090__p4333007">This request uses common headers. For details, see <a href="obs_04_0007.html#obs_04_0007__table25197309">Table 3</a>.</p>
</div>
<div class="section" id="obs_04_0090__section25517554"><h4 class="sectiontitle">Request Elements</h4><p id="obs_04_0090__p4645906">This request involves no elements.</p>
</div>
<div class="section" id="obs_04_0090__section28331395"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0090__screen59362926"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span>
<span class="normal">13</span>
<span class="normal">14</span>
<span class="normal">15</span>
<span class="normal">16</span>
<span class="normal">17</span>
<span class="normal">18</span>
<span class="normal">19</span>
<span class="normal">20</span></pre></div></td><td class="code"><div><pre><span></span>HTTP/1.1<span class="w"> </span>status_code
Date:<span class="w"> </span>date
Content-Length:<span class="w"> </span>length
Content-Type:<span class="w"> </span>application/xml<span class="w"> </span>
<span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;</span><span class="w"> </span>
<span class="nt">&lt;AccessControlPolicy</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://obs.region.example.com/doc/2015-06-30/&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;Owner&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;ID&gt;</span>id<span class="nt">&lt;/ID&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/Owner&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Delivered&gt;</span>true<span class="nt">&lt;/Delivered&gt;</span>
<span class="w"> </span><span class="nt">&lt;AccessControlList&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Grant&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Grantee&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;ID&gt;</span>id<span class="nt">&lt;/ID&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/Grantee&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Permission&gt;</span>permission<span class="nt">&lt;/Permission&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/Grant&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/AccessControlList&gt;</span><span class="w"> </span>
<span class="nt">&lt;/AccessControlPolicy&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0090__section53655969"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0090__p1512332591013">The response to the request uses common headers. For details, see <a href="obs_04_0013.html#obs_04_0013__d0e686">Table 1</a>.</p>
<p id="obs_04_0090__p47423499">In addition to the common response headers, the following message headers may also be used. For details, see <a href="#obs_04_0090__table995015721520">Table 2</a>.</p>
<div class="tablenoborder"><a name="obs_04_0090__table995015721520"></a><a name="table995015721520"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0090__table995015721520" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Additional response header</caption><thead align="left"><tr id="obs_04_0090__row43542352"><th align="left" class="cellrowborder" valign="top" width="40.400000000000006%" id="mcps1.3.8.4.2.3.1.1"><p id="obs_04_0090__p37269637">Header</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.599999999999994%" id="mcps1.3.8.4.2.3.1.2"><p id="obs_04_0090__p66050606">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0090__row48498868"><td class="cellrowborder" valign="top" width="40.400000000000006%" headers="mcps1.3.8.4.2.3.1.1 "><p id="obs_04_0090__p36094206">x-obs-version-id</p>
</td>
<td class="cellrowborder" valign="top" width="59.599999999999994%" headers="mcps1.3.8.4.2.3.1.2 "><p id="obs_04_0090__p37949556">Version number of an object.</p>
<p id="obs_04_0090__p6001692">Valid value: string</p>
<p id="obs_04_0090__p54015232">Default value: none</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0090__section13141676"><h4 class="sectiontitle">Response Elements</h4><p id="obs_04_0090__p13157639">The response message of the request returns the ACL information of the object. <a href="#obs_04_0090__table23161487">Table 3</a> describes the elements.</p>
<div class="tablenoborder"><a name="obs_04_0090__table23161487"></a><a name="table23161487"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0090__table23161487" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response elements</caption><thead align="left"><tr id="obs_04_0090__row5296547"><th align="left" class="cellrowborder" valign="top" width="35.35%" id="mcps1.3.9.3.2.3.1.1"><p id="obs_04_0090__p26367153">Element</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.64999999999999%" id="mcps1.3.9.3.2.3.1.2"><p id="obs_04_0090__p28519821">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0090__row64485412"><td class="cellrowborder" valign="top" width="35.35%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0090__p55935922">ID</p>
</td>
<td class="cellrowborder" valign="top" width="64.64999999999999%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0090__p34515844">User account ID</p>
<p id="obs_04_0090__p42207147">Type: string</p>
</td>
</tr>
<tr id="obs_04_0090__row44320003"><td class="cellrowborder" valign="top" width="35.35%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0090__p33150486">AccessControlList</p>
</td>
<td class="cellrowborder" valign="top" width="64.64999999999999%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0090__p834854">List of users and their permissions for the bucket.</p>
<p id="obs_04_0090__p7513688">Type: XML</p>
</td>
</tr>
<tr id="obs_04_0090__row514330"><td class="cellrowborder" valign="top" width="35.35%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0090__p41660763">Grant</p>
</td>
<td class="cellrowborder" valign="top" width="64.64999999999999%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0090__p19078608">Identifies the grantee and the permissions of the grantee.</p>
<p id="obs_04_0090__p37489745">Type: XML</p>
</td>
</tr>
<tr id="obs_04_0090__row1863393"><td class="cellrowborder" valign="top" width="35.35%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0090__p16717176">Grantee</p>
</td>
<td class="cellrowborder" valign="top" width="64.64999999999999%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0090__p11913978">Container for the details about the grantee.</p>
<p id="obs_04_0090__p40116944">Type: XML</p>
</td>
</tr>
<tr id="obs_04_0090__row236755121147"><td class="cellrowborder" valign="top" width="35.35%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0090__p1561393711411">Delivered</p>
</td>
<td class="cellrowborder" valign="top" width="64.64999999999999%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0090__p5676939411411">Indicates whether an object ACL inherits the ACL of a bucket.</p>
<p id="obs_04_0090__p4116250211411">Type: boolean</p>
</td>
</tr>
<tr id="obs_04_0090__row25508177"><td class="cellrowborder" valign="top" width="35.35%" headers="mcps1.3.9.3.2.3.1.1 "><p id="obs_04_0090__p52896485">Permission</p>
</td>
<td class="cellrowborder" valign="top" width="64.64999999999999%" headers="mcps1.3.9.3.2.3.1.2 "><p id="obs_04_0090__p56756893">Permissions of a specified user for the bucket.</p>
<p id="obs_04_0090__p41049994">Type: string</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0090__section51166221"><h4 class="sectiontitle">Error Responses</h4><p id="obs_04_0090__p36715252">No special error responses are returned. For details about error responses, see <a href="obs_04_0115.html#obs_04_0115__d0e843">Table 2</a>.</p>
</div>
<div class="section" id="obs_04_0090__section339018376100"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="obs_04_0090__screen875518434102"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span>GET<span class="w"> </span>/object011?acl<span class="w"> </span>HTTP/1.1
User-Agent:<span class="w"> </span>curl/7.29.0
Host:<span class="w"> </span>examplebucket.obs.region.example.com
Accept:<span class="w"> </span>*/*
Date:<span class="w"> </span>WED,<span class="w"> </span>01<span class="w"> </span>Jul<span class="w"> </span>2015<span class="w"> </span>04:45:55<span class="w"> </span>GMT
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:YcmvNQxItGjFeeC1K2HeUEp8MMM=
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0090__section179715418192"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="obs_04_0090__screen112135161910"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span>
<span class="normal">13</span>
<span class="normal">14</span>
<span class="normal">15</span>
<span class="normal">16</span>
<span class="normal">17</span>
<span class="normal">18</span>
<span class="normal">19</span>
<span class="normal">20</span>
<span class="normal">21</span>
<span class="normal">22</span>
<span class="normal">23</span>
<span class="normal">24</span>
<span class="normal">25</span>
<span class="normal">26</span>
<span class="normal">27</span>
<span class="normal">28</span>
<span class="normal">29</span>
<span class="normal">30</span>
<span class="normal">31</span>
<span class="normal">32</span>
<span class="normal">33</span>
<span class="normal">34</span>
<span class="normal">35</span></pre></div></td><td class="code"><div><pre><span></span>HTTP/1.1<span class="w"> </span>200<span class="w"> </span>OK
Server:<span class="w"> </span>OBS
x-obs-request-id:<span class="w"> </span>8DF400000163D3E650F3065C2295674C
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCS+wsHqRuA2Tx+mXUpNtBbWLPMle9CIx
Content-Type:<span class="w"> </span>application/xml
Date:<span class="w"> </span>WED,<span class="w"> </span>01<span class="w"> </span>Jul<span class="w"> </span>2015<span class="w"> </span>04:45:55<span class="w"> </span>GMT
Content-Length:<span class="w"> </span>769
<span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;</span>
<span class="nt">&lt;AccessControlPolicy</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://obs.region.example.com/doc/2015-06-30/&quot;</span><span class="nt">&gt;</span>
<span class="w"> </span><span class="nt">&lt;Owner&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;ID&gt;</span>b4bf1b36d9ca43d984fbcb9491b6fce9<span class="nt">&lt;/ID&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/Owner&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Delivered&gt;</span>false<span class="nt">&lt;/Delivered&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;AccessControlList&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Grant&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Grantee&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;ID&gt;</span>b4bf1b36d9ca43d984fbcb9491b6fce9<span class="nt">&lt;/ID&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/Grantee&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Permission&gt;</span>FULL_CONTROL<span class="nt">&lt;/Permission&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/Grant&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Grant&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Grantee&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;ID&gt;</span>783fc6652cf246c096ea836694f71855<span class="nt">&lt;/ID&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/Grantee&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Permission&gt;</span>READ<span class="nt">&lt;/Permission&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/Grant&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Grant&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Grantee&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Canned&gt;</span>Everyone<span class="nt">&lt;/Canned&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/Grantee&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;Permission&gt;</span>READ_ACP<span class="nt">&lt;/Permission&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/Grant&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/AccessControlList&gt;</span><span class="w"> </span>
<span class="nt">&lt;/AccessControlPolicy&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_04_0079.html">Operations on Objects</a></div>
</div>
</div>