forked from docs/doc-exports
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
261 lines
19 KiB
HTML
261 lines
19 KiB
HTML
<a name="obs_04_0047"></a><a name="obs_04_0047"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining the Cross-Region Replication Configuration of a Bucket</h1>
|
|
<div id="body53664231"><div class="section" id="obs_04_0047__section5584184924715"><h4 class="sectiontitle">Functions</h4><p class="msonormal" id="obs_04_0047__p21467548">This operation obtains the replication configuration information of a specified bucket. To perform this operation, you must have the <strong id="obs_04_0047__b33821318172014">GetReplicationConfiguration</strong> permission.</p>
|
|
</div>
|
|
<div class="section" id="obs_04_0047__section58990209"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0047__screen51835437"><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>/?replication<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<span class="w"> </span>
|
|
Authorization:authorization<span class="w"> </span>string
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0047__section61149837"><h4 class="sectiontitle">Request Parameters</h4><p class="msonormal" id="obs_04_0047__p26499484">This request contains no message parameters.</p>
|
|
</div>
|
|
<div class="section" id="obs_04_0047__section13477625"><h4 class="sectiontitle">Request Headers</h4><p class="msonormal" id="obs_04_0047__p66083493">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_0047__section54189766"><h4 class="sectiontitle">Request Elements</h4><p class="msonormal" id="obs_04_0047__p57811320">This request involves no elements.</p>
|
|
</div>
|
|
<div class="section" id="obs_04_0047__section17945854"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0047__screen52205343"><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<span class="w"> </span>
|
|
Date:<span class="w"> </span>date<span class="w"> </span>
|
|
Server:OBS<span class="w"> </span>
|
|
Content-Length:<span class="w"> </span>contentlength<span class="w"> </span>
|
|
|
|
<span class="cp"><?xml version="1.0" encoding="UTF-8"?></span><span class="w"> </span>
|
|
<span class="nt"><ReplicationConfiguration</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">"http://obs.example.com/doc/2006-03-01/"</span><span class="nt">></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Agency></span>testAcy<span class="nt"></Agency></span>
|
|
<span class="w"> </span><span class="nt"><Rule></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><ID></span>rule1<span class="nt"></ID></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Status></span>Enabled<span class="nt"></Status></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Prefix></Prefix></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Destination></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Bucket></span>exampletargetbucket<span class="nt"></Bucket></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><StorageClass></span>WARM<span class="nt"></StorageClass></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><DeleteData></span>Enabled<span class="nt"></DeleteData></span>
|
|
<span class="w"> </span><span class="nt"></Destination></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><HistoricalObjectReplication></span>Enabled<span class="nt"></HistoricalObjectReplication></span>
|
|
<span class="w"> </span><span class="nt"></Rule></span><span class="w"> </span>
|
|
<span class="nt"></ReplicationConfiguration></span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0047__section27294960"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0047__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_0047__section44328055"><h4 class="sectiontitle">Response Elements</h4><p class="msonormal" id="obs_04_0047__p9017759">This response contains elements to detail the configuration. The following table describes the elements.</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0047__table14050975" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Bucket replication configuration elements</caption><thead align="left"><tr id="obs_04_0047__row14147572"><th align="left" class="cellrowborder" valign="top" width="31.95%" id="mcps1.3.8.3.2.3.1.1"><p id="obs_04_0047__p5102690">Element</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="68.05%" id="mcps1.3.8.3.2.3.1.2"><p id="obs_04_0047__p10664785">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="obs_04_0047__row44223953"><td class="cellrowborder" valign="top" width="31.95%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0047__p25370417">ReplicationConfiguration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.05%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0047__p41737906">Container for the replication rules. A maximum of 100 rules can be configured. The size of the XML file can reach 50 KB.</p>
|
|
<p id="obs_04_0047__p40096838">Type: container</p>
|
|
<p id="obs_04_0047__p25327227">Child: Rule</p>
|
|
<p id="obs_04_0047__p26618459">Parent: none</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0047__row104037508209"><td class="cellrowborder" valign="top" width="31.95%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0047__p11111579205">Agency</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.05%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0047__p14111577201">Name of the agency, which can have a maximum of 64 characters.</p>
|
|
<p id="obs_04_0047__p1911157162011">Type: string</p>
|
|
<p id="obs_04_0047__p9115578208">Parent: ReplicationConfiguration</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0047__row10395144"><td class="cellrowborder" valign="top" width="31.95%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0047__p36700315">Rule</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.05%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0047__p19935510">Container of a specified replication rule.</p>
|
|
<p id="obs_04_0047__p45201866">The replication configuration must contain at least one rule. The maximum number of rules is 100.</p>
|
|
<p id="obs_04_0047__p4163618">Type: container</p>
|
|
<p id="obs_04_0047__p37472566">Parent: ReplicationConfiguration</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0047__row37737321"><td class="cellrowborder" valign="top" width="31.95%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0047__p36824194">ID</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.05%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0047__p29969743">Unique identifier of a rule, with a maximum length of 255 characters.</p>
|
|
<p id="obs_04_0047__p1292237">Type: string</p>
|
|
<p id="obs_04_0047__p11630137">Parent: Rule</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0047__row22653283"><td class="cellrowborder" valign="top" width="31.95%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0047__p22976659">Status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.05%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0047__p49170108">If the value of this element is <strong id="obs_04_0047__b842352706112931">Disabled</strong>, this rule will be ignored.</p>
|
|
<p id="obs_04_0047__p39877789">Type: string</p>
|
|
<p id="obs_04_0047__p23355781">Parent: Rule</p>
|
|
<p id="obs_04_0047__p8875437">Value options: <strong id="obs_04_0047__b032315311200">Enabled</strong>, <strong id="obs_04_0047__b103247532209">Disabled</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0047__row27742744"><td class="cellrowborder" valign="top" width="31.95%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0047__p32569778">Prefix</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.05%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0047__p20906381">Prefix of an object key name, applicable to one or more objects. If the <strong id="obs_04_0047__b499142872620">Prefix</strong> is left blank, the cross-region replication rule is applied to the whole bucket.</p>
|
|
<p id="obs_04_0047__p53939706">The maximum length of a prefix is 1,024 characters. Duplicated prefixes are not supported.</p>
|
|
<p id="obs_04_0047__p15695313">Type: string</p>
|
|
<p id="obs_04_0047__p7040089">Parent: Rule</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0047__row31951537"><td class="cellrowborder" valign="top" width="31.95%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0047__p37937694">Destination</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.05%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0047__p53054355">Container for the destination bucket information.</p>
|
|
<p id="obs_04_0047__p7727153">Type: container</p>
|
|
<p id="obs_04_0047__p2435513">Parent: Rule</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0047__row30658935"><td class="cellrowborder" valign="top" width="31.95%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0047__p345838">Bucket</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.05%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0047__p28012880">Bucket used to store object copies that are marked by rules.</p>
|
|
<p id="obs_04_0047__p50789334">If the replication configuration contains multiple rules, the rules must specify the same bucket as the destination bucket.</p>
|
|
<p id="obs_04_0047__p54450823">Type: string</p>
|
|
<p id="obs_04_0047__p20295366">Parent: Destination</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0047__row31372179"><td class="cellrowborder" valign="top" width="31.95%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0047__p58118584">StorageClass</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.05%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0047__p9984849">Storage class of an object.</p>
|
|
<p id="obs_04_0047__p22754781">Type: string</p>
|
|
<p id="obs_04_0047__p3466439">Parent: Destination</p>
|
|
<p id="obs_04_0047__p31197952">Value options: <strong id="obs_04_0047__b416355913393">STANDARD</strong>, <strong id="obs_04_0047__b89857124012">WARM</strong>, <strong id="obs_04_0047__b108221848401">COLD</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0047__row259515810296"><td class="cellrowborder" valign="top" width="31.95%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0047__p1011725114611">DeleteData</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.05%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0047__p741071644716">Keyword for synchronizing object deletion operations. If the value is <strong id="obs_04_0047__b1877417551657">Enabled</strong>, the object deletion for the source bucket will be replicated to the destination bucket.</p>
|
|
<p id="obs_04_0047__p144101167471">Type: string</p>
|
|
<p id="obs_04_0047__p19410816164719">Parent: Destination</p>
|
|
<p id="obs_04_0047__p54101316144719">Value options: <strong id="obs_04_0047__b19521843173218">Enabled</strong> and <strong id="obs_04_0047__b1995234313212">Disabled</strong> (If this element is absent from the request, <strong id="obs_04_0047__b3952134333212">Disabled</strong> is applied by default.)</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="obs_04_0047__row21591347836"><td class="cellrowborder" valign="top" width="31.95%" headers="mcps1.3.8.3.2.3.1.1 "><p id="obs_04_0047__p1916024716315">HistoricalObjectReplication</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.05%" headers="mcps1.3.8.3.2.3.1.2 "><p id="obs_04_0047__p419115115473">Keyword for copying a historical object. If the value is <strong id="obs_04_0047__b8853171412366">Enabled</strong>, historical objects meeting this rule are copied.</p>
|
|
<p id="obs_04_0047__p16191145194714">Type: string</p>
|
|
<p id="obs_04_0047__p18191135112470">Parent: Rule</p>
|
|
<p id="obs_04_0047__p1319165118472">Value options: <strong id="obs_04_0047__b18760104517322">Enabled</strong> and <strong id="obs_04_0047__b167601445153211">Disabled</strong> (If this element is absent from the request, <strong id="obs_04_0047__b14760164513327">Disabled</strong> is applied by default.)</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0047__section63408179"><h4 class="sectiontitle">Error Responses</h4><p class="msonormal" id="obs_04_0047__p7728807">The following table describes the error response for this request.</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0047__table2450403" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Error response elements</caption><thead align="left"><tr id="obs_04_0047__row38854204"><th align="left" class="cellrowborder" valign="top" width="28.000000000000004%" id="mcps1.3.9.3.2.5.1.1"><p id="obs_04_0047__p60182838">Error Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.9.3.2.5.1.2"><p id="obs_04_0047__p42971700">Description</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.9.3.2.5.1.3"><p id="obs_04_0047__p58155679">HTTP Response Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.9.3.2.5.1.4"><p id="obs_04_0047__p12989534">SOAP Error Code Prefix</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="obs_04_0047__row45519322"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.9.3.2.5.1.1 "><p id="obs_04_0047__p63186426">NoSuchReplicationConfiguration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.9.3.2.5.1.2 "><p id="obs_04_0047__p17826854">Cross-region replication configuration does not exist.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.9.3.2.5.1.3 "><p id="obs_04_0047__p34689095">404 not found</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.9.3.2.5.1.4 "><p id="obs_04_0047__p58353349">Client</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0047__section14482163815396"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="obs_04_0047__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>/?replication<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>27<span class="w"> </span>Jun<span class="w"> </span>2018<span class="w"> </span>13:42:40<span class="w"> </span>+0000
|
|
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:jGHviInfRyOkT/EpySpua1hlBuY=
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="section" id="obs_04_0047__section76081155815"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="obs_04_0047__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></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>B59500000164417B57D02F7EF8823152
|
|
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSHu6lz4vgk5G3E32OFcIPEZZgdOEYE/
|
|
Content-Type:<span class="w"> </span>application/xml
|
|
Date:<span class="w"> </span>Wed,<span class="w"> </span>27<span class="w"> </span>Jun<span class="w"> </span>2018<span class="w"> </span>13:42:39<span class="w"> </span>GMT
|
|
Content-Length:<span class="w"> </span>337
|
|
|
|
<span class="cp"><?xml version="1.0" encoding="utf-8"?></span>
|
|
<span class="nt"><ReplicationConfiguration</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">"http://obs.example.com/doc/2006-03-01/"</span><span class="nt">></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Rule></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><ID></span>Rule-1<span class="nt"></ID></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Status></span>Enabled<span class="nt"></Status></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Prefix></Prefix></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Destination></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Bucket></span>dstbucket<span class="nt"></Bucket></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><StorageClass></span>STANDARD<span class="nt"></StorageClass></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><DeleteData></span>Enabled<span class="nt"></DeleteData></span>
|
|
<span class="w"> </span><span class="nt"></Destination></span>
|
|
<span class="w"> </span><span class="nt"><HistoricalObjectReplication></span>Enabled<span class="nt"></HistoricalObjectReplication></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"></Rule></span><span class="w"> </span>
|
|
<span class="w"> </span><span class="nt"><Agency></span>testAcy<span class="nt"></Agency></span><span class="w"> </span>
|
|
<span class="nt"></ReplicationConfiguration></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>
|
|
|