doc-exports/docs/obs/s3api/en-us_topic_0250433783.html
zhangyue 6fcdbfd13e OBS S3 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-02-26 11:17:13 +00:00

117 lines
8.6 KiB
HTML

<a name="EN-US_TOPIC_0250433783"></a><a name="EN-US_TOPIC_0250433783"></a>
<h1 class="topictitle1">GET Bucket request payment</h1>
<div id="body1590721492986"><p id="EN-US_TOPIC_0250433783__p62476463203448">This API obtains the requester-pays configuration information of a bucket.</p>
<div class="section" id="EN-US_TOPIC_0250433783__section57518732"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0250433783__screen6103826"><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></pre></div></td><td class="code"><div><pre><span></span>GET<span class="w"> </span>/?requestPayment<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
Content-Length:<span class="w"> </span>length
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0250433783__section47906541"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0250433783__p26589862">This request involves no parameters.</p>
</div>
<div class="section" id="EN-US_TOPIC_0250433783__section28505693"><h4 class="sectiontitle">Request Headers</h4><p id="EN-US_TOPIC_0250433783__p6295248">This request uses common headers. For details about common request headers, see section <a href="en-us_topic_0125560462.html">Common Request Headers</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0250433783__section55224652"><h4 class="sectiontitle">Request Elements</h4><p id="EN-US_TOPIC_0250433783__p31176214">This request involves no elements.</p>
</div>
<div class="section" id="EN-US_TOPIC_0250433783__section46270551"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0250433783__screen10214176"><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></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>type
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; standalone=&quot;yes&quot;?&gt;</span>
<span class="nt">&lt;RequestPaymentConfiguration</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;Payer&gt;</span>Payer<span class="nt">&lt;/Payer&gt;</span>
<span class="nt">&lt;/RequestPaymentConfiguration&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0250433783__section13781782"><h4 class="sectiontitle">Response Headers</h4><p id="EN-US_TOPIC_0250433783__p63490983">This response uses common headers. For details about common response headers, see section <a href="en-us_topic_0125560484.html">Common Response Headers</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0250433783__section56927182"><h4 class="sectiontitle">Response Elements</h4><p id="EN-US_TOPIC_0250433783__p7433144132213">This response contains the following elements:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0250433783__d0e7246" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0250433783__row52104816"><th align="left" class="cellrowborder" valign="top" width="31.209999999999997%" id="mcps1.3.8.3.1.3.1.1"><p id="EN-US_TOPIC_0250433783__p59740538"><strong id="EN-US_TOPIC_0250433783__b810353212152">Element</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="68.78999999999999%" id="mcps1.3.8.3.1.3.1.2"><p id="EN-US_TOPIC_0250433783__p64308536"><strong id="EN-US_TOPIC_0250433783__b788183416154">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0250433783__row64406127"><td class="cellrowborder" valign="top" width="31.209999999999997%" headers="mcps1.3.8.3.1.3.1.1 "><p id="EN-US_TOPIC_0250433783__p49513773">RequestPaymentConfiguration</p>
</td>
<td class="cellrowborder" valign="top" width="68.78999999999999%" headers="mcps1.3.8.3.1.3.1.2 "><p id="EN-US_TOPIC_0250433783__p51192643">Elements of the requester-pays configuration.</p>
<p id="EN-US_TOPIC_0250433783__p58080607">Type: element</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0250433783__row62178457"><td class="cellrowborder" valign="top" width="31.209999999999997%" headers="mcps1.3.8.3.1.3.1.1 "><p id="EN-US_TOPIC_0250433783__p3290281">Payer</p>
</td>
<td class="cellrowborder" valign="top" width="68.78999999999999%" headers="mcps1.3.8.3.1.3.1.2 "><p id="EN-US_TOPIC_0250433783__p65186226">Identifier of who pays for the bucket.</p>
<p id="EN-US_TOPIC_0250433783__p49805123">Type: enumeration</p>
<p id="EN-US_TOPIC_0250433783__p8287634152514">Ancestor: <strong id="EN-US_TOPIC_0250433783__b1129313201612">RequestPaymentConfiguration</strong></p>
<p id="EN-US_TOPIC_0250433783__p8695201710314">Valid values:</p>
<ul id="EN-US_TOPIC_0250433783__ul176341522143118"><li id="EN-US_TOPIC_0250433783__li13634152219310"><strong id="EN-US_TOPIC_0250433783__b152101216101619">BucketOwner</strong>: The bucket owner pays all fees associated with the bucket.</li><li id="EN-US_TOPIC_0250433783__li6814824203113"><strong id="EN-US_TOPIC_0250433783__b13898817181617">Requester</strong>: The requester pays for data transfer and API calls associated with accessing resources in the bucket, while the bucket owner pays for data storage in the bucket.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0250433783__section42582590"><h4 class="sectiontitle">Error Responses</h4><p id="EN-US_TOPIC_0250433783__p45833411">No special error responses are returned. For details about error responses, see <a href="en-us_topic_0125560440.html#EN-US_TOPIC_0125560440__table30733758">Table 1</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0250433783__section32323009"><h4 class="sectiontitle">Sample Request</h4><pre class="screen" id="EN-US_TOPIC_0250433783__screen6066468122732">GET /?requestPayment HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.example.com
Accept: */*
Date: Tue, 03 Mar 2020 12:07:05 GMT
Authorization: authorization</pre>
</div>
<div class="section" id="EN-US_TOPIC_0250433783__section22471632"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0250433783__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></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-amz-request-id:<span class="w"> </span>0000016A6C21AD79654C09D9AA45EB5D
x-amz-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSmfq4hegf1QZv8/ewfveE4B566v5DZ8
Content-Type:<span class="w"> </span>application/xml
Date:<span class="w"> </span>Tue,<span class="w"> </span>30<span class="w"> </span>Apr<span class="w"> </span>2019<span class="w"> </span>02:45:07<span class="w"> </span>GMT
Content-Length:<span class="w"> </span>0
<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;RequestPaymentConfiguration</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;Payer&gt;</span>Requester<span class="nt">&lt;/Payer&gt;</span>
<span class="nt">&lt;/RequestPaymentConfiguration&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0125560493.html">Operations on Buckets</a></div>
</div>
</div>