vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/obs/api-ref/obs_04_0033.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

215 lines
16 KiB
HTML
Raw Blame History

<a name="obs_04_0033"></a><a name="obs_04_0033"></a>
<h1 class="topictitle1">Obtaining a Bucket Logging Configuration</h1>
<div id="body36184237"><div class="section" id="obs_04_0033__section5584184924715"><h4 class="sectiontitle">Functions</h4><p class="msonormal" id="obs_04_0033__p45178959">This operation queries the logging status of a bucket. It uses the logging sub-resource to return the logging status of a bucket.</p>
<p class="msonormal" id="obs_04_0033__p3957453">Only the bucket owner or users granted the <strong id="obs_04_0033__b16853677">GetBucketLogging</strong> permission can query the bucket logging status.</p>
</div>
<div class="section" id="obs_04_0033__section35617081"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0033__screen45242057"><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>/?logging<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_0033__section52118276"><h4 class="sectiontitle">Request Parameters</h4><p class="msonormal" id="obs_04_0033__p55693145">This request contains no message parameters.</p>
</div>
<div class="section" id="obs_04_0033__section66411303"><h4 class="sectiontitle">Request Headers</h4><p class="msonormal" id="obs_04_0033__p14850892">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_0033__section60830819"><h4 class="sectiontitle">Request Elements</h4><p class="msonormal" id="obs_04_0033__p21773598">This request involves no elements.</p>
</div>
<div class="section" id="obs_04_0033__section10606466"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0033__screen18830995"><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></pre></div></td><td class="code"><div><pre><span></span>HTTP/1.1<span class="w"> </span>status_code
Content-Type:<span class="w"> </span>application/xml<span class="w"> </span>
Date:<span class="w"> </span>date
Content-Length:<span class="w"> </span>length
<span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span><span class="w"> </span>
<span class="nt">&lt;BucketLoggingStatus</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="nt">&lt;Agency&gt;</span>agency-name<span class="nt">&lt;/Agency&gt;</span>
<span class="nt">&lt;LoggingEnabled&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;TargetBucket&gt;</span>bucketName<span class="nt">&lt;/TargetBucket&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;TargetPrefix&gt;</span>prefix<span class="nt">&lt;/TargetPrefix&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;TargetGrants&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;/TargetGrants&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/LoggingEnabled&gt;</span><span class="w"> </span>
<span class="nt">&lt;/BucketLoggingStatus&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0033__section28349331"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0033__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_0033__section53817393"><h4 class="sectiontitle">Response Elements</h4><p class="msonormal" id="obs_04_0033__p22012767">This response contains elements to specify the bucket logging status. <a href="#obs_04_0033__table64048341152231">Table 1</a> describes the elements.</p>
<div class="tablenoborder"><a name="obs_04_0033__table64048341152231"></a><a name="table64048341152231"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0033__table64048341152231" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response elements</caption><thead align="left"><tr id="obs_04_0033__row52589208"><th align="left" class="cellrowborder" valign="top" width="36.86%" id="mcps1.3.8.3.2.3.1.1"><p id="obs_04_0033__p31867473">Element</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="63.13999999999999%" id="mcps1.3.8.3.2.3.1.2"><p id="obs_04_0033__p31128490">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0033__row21749853"><td class="cellrowborder" valign="top" width="36.86%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0033__p16907655">BucketLoggingStatus</p>
</td>
<td class="cellrowborder" valign="top" width="63.13999999999999%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0033__p27342834">Container for logging status information</p>
<p id="obs_04_0033__p44758919">Type: container</p>
</td>
</tr>
<tr id="obs_04_0033__row16316115912195"><td class="cellrowborder" valign="top" width="36.86%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0033__p4316195912191">Agency</p>
</td>
<td class="cellrowborder" valign="top" width="63.13999999999999%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0033__p174844168555">Name of the agency created by the owner of the logging bucket for uploading log files by OBS</p>
<p id="obs_04_0033__p1910012645913">Type: string</p>
</td>
</tr>
<tr id="obs_04_0033__row14344617"><td class="cellrowborder" valign="top" width="36.86%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0033__p21063366">LoggingEnabled</p>
</td>
<td class="cellrowborder" valign="top" width="63.13999999999999%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0033__p28411075">Container for logging information. This element enables or disables the logging function. Present this element when enabling the logging. Otherwise, absent it.</p>
<p id="obs_04_0033__p54373085">Type: container</p>
</td>
</tr>
<tr id="obs_04_0033__row43749502"><td class="cellrowborder" valign="top" width="36.86%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0033__p54048780">Grant</p>
</td>
<td class="cellrowborder" valign="top" width="63.13999999999999%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0033__p15875099">Container for the grantee and the granted permissions</p>
<p id="obs_04_0033__p8658171">Type: container</p>
</td>
</tr>
<tr id="obs_04_0033__row3573467"><td class="cellrowborder" valign="top" width="36.86%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0033__p21015387">Grantee</p>
</td>
<td class="cellrowborder" valign="top" width="63.13999999999999%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0033__p24524796">Container for the user that is granted with the logging permission</p>
<p id="obs_04_0033__p19396576">Type: container</p>
</td>
</tr>
<tr id="obs_04_0033__row47242943"><td class="cellrowborder" valign="top" width="36.86%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0033__p1473202">ID</p>
</td>
<td class="cellrowborder" valign="top" width="63.13999999999999%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0033__p52220517">Grantee domain ID, a globally unique ID</p>
<p id="obs_04_0033__p222606">Type: string</p>
</td>
</tr>
<tr id="obs_04_0033__row13015841"><td class="cellrowborder" valign="top" width="36.86%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0033__p47650167">Permission</p>
</td>
<td class="cellrowborder" valign="top" width="63.13999999999999%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0033__p34458318">Logging permission granted to the grantee for a bucket. The bucket owner is automatically granted the <strong id="obs_04_0033__b102417277217115">FULL_CONTROL</strong> permission when creating the bucket. Logging permissions control access to different logs.</p>
<p id="obs_04_0033__p41689409">Type: string</p>
<p id="obs_04_0033__p39660365">Value options: <strong id="obs_04_0033__b582344710491">FULL_CONTROL</strong>, <strong id="obs_04_0033__b78233473497">READ</strong>, <strong id="obs_04_0033__b11823174715490">WRITE</strong></p>
</td>
</tr>
<tr id="obs_04_0033__row55595147"><td class="cellrowborder" valign="top" width="36.86%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0033__p6913047">TargetBucket</p>
</td>
<td class="cellrowborder" valign="top" width="63.13999999999999%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0033__p23085895">When enabling the logging function, the owner of the bucket being logged can specify a target bucket to store the generated log files. Log files generated for multiple buckets can be stored in the same target bucket. If you do so, you need to specify different TargetPrefixes to classify logs for different buckets.</p>
<p id="obs_04_0033__p6446464">Type: string</p>
</td>
</tr>
<tr id="obs_04_0033__row1852084"><td class="cellrowborder" valign="top" width="36.86%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0033__p15801154">TargetPrefix</p>
</td>
<td class="cellrowborder" valign="top" width="63.13999999999999%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0033__p4825108">You can specify a prefix using this element so that log files are named with this prefix.</p>
<p id="obs_04_0033__p43425979">Type: string</p>
</td>
</tr>
<tr id="obs_04_0033__row49263782"><td class="cellrowborder" valign="top" width="36.86%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0033__p30943414">TargetGrants</p>
</td>
<td class="cellrowborder" valign="top" width="63.13999999999999%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0033__p23388586">Container for granting information</p>
<p id="obs_04_0033__p9170685">Type: container</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0033__section14594492"><h4 class="sectiontitle">Error Responses</h4><p class="msonormal" id="obs_04_0033__p39326561">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_0033__section14482163815396"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="obs_04_0033__screen8484163863919"><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>/?logging<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:42:46<span class="w"> </span>GMT
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:hUk+jTnR07hcKwJh4ousF2E1U3E=
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0033__section76081155815"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="obs_04_0033__screen8485113814"><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></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>BF260000016436B8EEE7FBA2AA3335E3
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCShuQJoWFpS77C8bOv1mqURv0UY+0ejx
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:42:46<span class="w"> </span>GMT
Content-Length:<span class="w"> </span>429
<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;BucketLoggingStatus</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;Agency&gt;</span>agency-name<span class="nt">&lt;/Agency&gt;</span>
<span class="w"> </span><span class="nt">&lt;LoggingEnabled&gt;</span>
<span class="w"> </span><span class="nt">&lt;TargetBucket&gt;</span>log-bucket<span class="nt">&lt;/TargetBucket&gt;</span>
<span class="w"> </span><span class="nt">&lt;TargetPrefix&gt;</span>mybucket-access_log-/<span class="nt">&lt;/TargetPrefix&gt;</span>
<span class="w"> </span><span class="nt">&lt;TargetGrants&gt;</span>
<span class="w"> </span><span class="nt">&lt;Grant&gt;</span>
<span class="w"> </span><span class="nt">&lt;Grantee&gt;</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="nt">&lt;/Grantee&gt;</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="nt">&lt;/Grant&gt;</span>
<span class="w"> </span><span class="nt">&lt;/TargetGrants&gt;</span>
<span class="w"> </span><span class="nt">&lt;/LoggingEnabled&gt;</span>
<span class="nt">&lt;/BucketLoggingStatus&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>
View Git Blame Copy Permalink