forked from docs/doc-exports
zhangyue
d5b1108742
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
128 lines
9.9 KiB
HTML
128 lines
9.9 KiB
HTML
<a name="obs_04_0068"></a><a name="obs_04_0068"></a>
|
|
|
|
<h1 class="topictitle1">Configuring the Requester-Pays Function for a Bucket</h1>
|
|
<div id="body1583235745573"><div class="section" id="obs_04_0068__section5584184924715"><h4 class="sectiontitle">Functions</h4><div class="msonormal" id="obs_04_0068__p42175431">The requester-pays configuration allows the requester to pay for data transfer and API calls associated with accessing the requested OBS resources, while the bucket owner only pays for data storage.<div class="note" id="obs_04_0068__note114929164720"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_04_0068__p14488174014136">To access a requester-pays bucket, users (except the bucket owner and IAM users under the same account as the bucket owner) must add the <strong id="obs_04_0068__b32941482502">x-obs-request-payer: requester</strong> header in the request, indicating that the requester agrees to pay for the request and traffic. If this header is not included in the request, the authentication fails and error "403 Forbidden" is returned. If the response returned by the server includes the <strong id="obs_04_0068__b12397221285">x-obs-request-charged: requester</strong> header, the requester is billed for the request. This rule is applicable to all API requests against requester-pays buckets.</p>
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0068__section31076456"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0068__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>
|
|
<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>PUT<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
|
|
|
|
<span class="nt"><RequestPaymentConfiguration></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Payer></span>Payer<span class="nt"></Payer></span>
|
|
<span class="nt"></RequestPaymentConfiguration></span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0068__section11252648"><h4 class="sectiontitle">Request Parameters</h4><p class="msonormal" id="obs_04_0068__p142055">This request contains no message parameters.</p>
|
|
</div>
|
|
<div class="section" id="obs_04_0068__section34164974"><h4 class="sectiontitle">Request Headers</h4><p class="msonormal" id="obs_04_0068__p11506457">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_0068__section39049314"><h4 class="sectiontitle">Request Elements</h4><p class="msonormal" id="obs_04_0068__p66708519">This request contains elements that specify the requester-pays configuration for the bucket. Configuration information is uploaded in the XML format. The following table lists request elements.</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0068__d0e7246" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Elements for configuring the requester-pays function</caption><thead align="left"><tr id="obs_04_0068__row52104816"><th align="left" class="cellrowborder" valign="top" width="26.540000000000003%" id="mcps1.3.5.3.2.4.1.1"><p id="obs_04_0068__p59740538">Element</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.15%" id="mcps1.3.5.3.2.4.1.2"><p id="obs_04_0068__p64308536">Description</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.310000000000002%" id="mcps1.3.5.3.2.4.1.3"><p id="obs_04_0068__p38936003">Mandatory</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="obs_04_0068__row64406127"><td class="cellrowborder" valign="top" width="26.540000000000003%" headers="mcps1.3.5.3.2.4.1.1 "><p id="obs_04_0068__p49513773">RequestPaymentConfiguration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.15%" headers="mcps1.3.5.3.2.4.1.2 "><p id="obs_04_0068__p51192643">Root node of the requester-pays configuration.</p>
|
|
<p id="obs_04_0068__p58080607">Ancestor: none</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.310000000000002%" headers="mcps1.3.5.3.2.4.1.3 "><p id="obs_04_0068__p6908717">Yes</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0068__row62178457"><td class="cellrowborder" valign="top" width="26.540000000000003%" headers="mcps1.3.5.3.2.4.1.1 "><p id="obs_04_0068__p3290281">Payer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.15%" headers="mcps1.3.5.3.2.4.1.2 "><p id="obs_04_0068__p65186226">Specifies who pays for accessing resources in the bucket.</p>
|
|
<p id="obs_04_0068__p49805123">Type: string</p>
|
|
<p id="obs_04_0068__p45592923">Ancestor: <strong id="obs_04_0068__b879392483017">RequestPaymentConfiguration</strong></p>
|
|
<p id="obs_04_0068__p8695201710314">Value options:</p>
|
|
<ul id="obs_04_0068__ul176341522143118"><li id="obs_04_0068__li13634152219310"><strong id="obs_04_0068__b0990925913">BucketOwner</strong>: The bucket owner pays all fees associated with the bucket.</li><li id="obs_04_0068__li6814824203113"><strong id="obs_04_0068__b1978517211694">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>
|
|
<td class="cellrowborder" valign="top" width="15.310000000000002%" headers="mcps1.3.5.3.2.4.1.3 "><p id="obs_04_0068__p18353199">Yes</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0068__section15899509"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0068__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></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
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0068__section8877856"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0068__p5510113014018">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_0068__section12791844"><h4 class="sectiontitle">Response Elements</h4><p class="msonormal" id="obs_04_0068__p27783412">This response involves no elements.</p>
|
|
</div>
|
|
<div class="section" id="obs_04_0068__section48017739"><h4 class="sectiontitle">Error Responses</h4><p class="msonormal" id="obs_04_0068__p35863881">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_0068__section14482163815396"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="obs_04_0068__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>
|
|
<span class="normal"> 7</span>
|
|
<span class="normal"> 8</span>
|
|
<span class="normal"> 9</span>
|
|
<span class="normal">10</span></pre></div></td><td class="code"><div><pre><span></span>PUT/?requestPayment<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>Tue,<span class="w"> </span>03<span class="w"> </span>Mar<span class="w"> </span>2020<span class="w"> </span>12:07:05<span class="w"> </span>GMT
|
|
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:5DGAS7SBbMC1YTC4tNXY57Zl2Fo=
|
|
|
|
<span class="nt"><RequestPaymentConfiguration></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Payer></span>Requester<span class="nt"></Payer></span>
|
|
<span class="nt"></RequestPaymentConfiguration></span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0068__section76081155815"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="obs_04_0068__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></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>0000016A6C21AD79654C09D9AA45EB5D
|
|
x-obs-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
|
|
</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>
|
|
|