doc-exports/docs/obs/api-ref/obs_04_0031.html
zhangyue 7d2a7ec198 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>
2024-11-05 16:37:11 +00:00

221 lines
16 KiB
HTML

<a name="obs_04_0031"></a><a name="obs_04_0031"></a>
<h1 class="topictitle1">Obtaining Bucket ACL Information</h1>
<div id="body12000724"><div class="section" id="obs_04_0031__section5584184924715"><h4 class="sectiontitle">Functions</h4><p id="obs_04_0031__p25643130">This operation returns the ACL information of a bucket. To obtain the ACL of a bucket, you need to have the <strong id="obs_04_0031__b209837412517435">READ_ACP</strong> or <strong id="obs_04_0031__b33275896917435">FULL_CONTROL</strong> permission for the bucket.</p>
</div>
<div class="section" id="obs_04_0031__section29461583"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0031__screen32534588"><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>/?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_0031__section63827656"><h4 class="sectiontitle">Request Parameters</h4><p id="obs_04_0031__p62863594">This request contains no message parameters.</p>
</div>
<div class="section" id="obs_04_0031__section37578000"><h4 class="sectiontitle">Request Headers</h4><p id="obs_04_0031__p58786336">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_0031__section2657687"><h4 class="sectiontitle">Request Elements</h4><p id="obs_04_0031__p39784396">This request involves no elements.</p>
</div>
<div class="section" id="obs_04_0031__section23919191"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0031__screen1310673"><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;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;Delivered&gt;</span>false<span class="nt">&lt;/Delivered&gt;</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_0031__section13946127"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0031__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>
</div>
<div class="section" id="obs_04_0031__section58406281"><h4 class="sectiontitle">Response Elements</h4><p id="obs_04_0031__p26852358">This response returns information (in the form of elements) about the bucket ACL. <a href="#obs_04_0031__table46938871">Table 1</a> describes the elements.</p>
<div class="tablenoborder"><a name="obs_04_0031__table46938871"></a><a name="table46938871"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0031__table46938871" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response elements</caption><thead align="left"><tr id="obs_04_0031__row22931300"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.8.3.2.3.1.1"><p id="obs_04_0031__p45495974">Element</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.8.3.2.3.1.2"><p id="obs_04_0031__p14786732">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0031__row42109833"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0031__p55453326">Owner</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0031__p62534407">Bucket owner</p>
<p id="obs_04_0031__p25938755">Type: XML</p>
</td>
</tr>
<tr id="obs_04_0031__row32122205"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0031__p51761783">ID</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0031__p31954877">Account ID</p>
<p id="obs_04_0031__p19158445">Type: string</p>
</td>
</tr>
<tr id="obs_04_0031__row49697845"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0031__p66102514">AccessControlList</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0031__p52703436">Indicates the ACL that records all users who have permissions to access the bucket and the permissions granted to the users.</p>
<p id="obs_04_0031__p4568879">Type: XML</p>
</td>
</tr>
<tr id="obs_04_0031__row41119914"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0031__p42378741">Grant</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0031__p10125972">Container for the grantee and the granted permissions</p>
<p id="obs_04_0031__p24024887">Type: XML</p>
</td>
</tr>
<tr id="obs_04_0031__row14897392"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0031__p65838064">Grantee</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0031__p31282940">Grantee information</p>
<p id="obs_04_0031__p13111011">Type: XML</p>
</td>
</tr>
<tr id="obs_04_0031__row22578699105646"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0031__p39717156105654">Canned</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0031__p62973095105654">Grants permissions to all users.</p>
<p id="obs_04_0031__p29886945105654">Type: string. The value can only be <strong id="obs_04_0031__b16255111423415">Everyone</strong>.</p>
</td>
</tr>
<tr id="obs_04_0031__row33068941105651"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0031__p32426193105654">Delivered</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0031__p9275973105654">Indicates whether the bucket ACL is applied to objects in the bucket.</p>
<p id="obs_04_0031__p16374900105654">Type: boolean</p>
</td>
</tr>
<tr id="obs_04_0031__row50890237"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0031__p28468571">Permission</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0031__p24252925">Grantee's permission for a bucket</p>
<p id="obs_04_0031__p16949740">Type: string</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0031__section55894487"><h4 class="sectiontitle">Error Responses</h4><p id="obs_04_0031__p30751663">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_0031__section14819157124617"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="obs_04_0031__screen42901510155312"><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>/?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>02:39:28<span class="w"> </span>GMT
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:X7HtzGsIEkzJbd8vo1DRu30vVrs=
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0031__section76081155815"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="obs_04_0031__screen18548202314552"><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>BF260000016436B69D82F14E93528658
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSjTh8661+HF5y8uAnTOBIpNO133hji+
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>02:39:28<span class="w"> </span>GMT
Content-Length:<span class="w"> </span>784
<span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;</span>
<span class="nt">&lt;AccessControlPolicy</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">&quot;http://obs.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;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;Delivered&gt;</span>false<span class="nt">&lt;/Delivered&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_0026.html">Advanced Bucket Settings</a></div>
</div>
</div>