doc-exports/docs/obs/api-ref/obs_04_0072.html
zhangyue d84e24d182 OBS API doc
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-03-03 09:35:22 +00:00

126 lines
9.4 KiB
HTML

<a name="obs_04_0072"></a><a name="obs_04_0072"></a>
<h1 class="topictitle1">Obtaining the Static Website Hosting Configuration of a Bucket</h1>
<div id="body30395827"><div class="section" id="obs_04_0072__section5584184924715"><h4 class="sectiontitle">Functions</h4><p class="msonormal" id="obs_04_0072__p56290971">You can perform this operation to get the static website hosting configuration of a bucket.</p>
<p class="msonormal" id="obs_04_0072__p36856693">To perform this operation, you must have the <strong id="obs_04_0072__b852412521206">GetBucketWebsite</strong> permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.</p>
</div>
<div class="section" id="obs_04_0072__section63274784"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0072__screen46142899"><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>/?website<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_0072__section32602150"><h4 class="sectiontitle">Request Parameters</h4><p class="msonormal" id="obs_04_0072__p20996874">This request contains no message parameters.</p>
</div>
<div class="section" id="obs_04_0072__section24983894"><h4 class="sectiontitle">Request Headers</h4><p class="msonormal" id="obs_04_0072__p23025213">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_0072__section23528459"><h4 class="sectiontitle">Request Elements</h4><p class="msonormal" id="obs_04_0072__p8164380">This request involves no elements.</p>
</div>
<div class="section" id="obs_04_0072__section10429540"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0072__screen57335080"><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>HTTP/1.1<span class="w"> </span>status_code
Date:<span class="w"> </span>date
Content-Type:<span class="w"> </span>type
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="w"> </span>
<span class="nt">&lt;WebsiteConfiguration</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="w"> </span><span class="nt">&lt;RedirectAllRequestsTo&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;HostName&gt;</span>hostName<span class="nt">&lt;/HostName&gt;</span><span class="w"> </span>
<span class="w"> </span><span class="nt">&lt;/RedirectAllRequestsTo&gt;</span><span class="w"> </span>
<span class="nt">&lt;/WebsiteConfiguration&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0072__section26757004"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0072__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_0072__section39486451"><h4 class="sectiontitle">Response Elements</h4><p class="msonormal" id="obs_04_0072__p63339175">This response contains elements the same as those used by the PutBucketWebsite request. For details, see <a href="obs_04_0071.html#obs_04_0071__section12388580153122">Request Elements</a>.</p>
</div>
<div class="section" id="obs_04_0072__section19833747"><h4 class="sectiontitle">Error Responses</h4><p class="msonormal" id="obs_04_0072__p3360155"><a href="#obs_04_0072__table12494839144020">Table 1</a> describes possible special errors in this request.</p>
<div class="tablenoborder"><a name="obs_04_0072__table12494839144020"></a><a name="table12494839144020"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0072__table12494839144020" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Special error</caption><thead align="left"><tr id="obs_04_0072__row29840902"><th align="left" class="cellrowborder" valign="top" width="39.795918367346935%" id="mcps1.3.9.3.2.4.1.1"><p id="obs_04_0072__p1194035">Error Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="35.714285714285715%" id="mcps1.3.9.3.2.4.1.2"><p id="obs_04_0072__p29608000">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.489795918367346%" id="mcps1.3.9.3.2.4.1.3"><p id="obs_04_0072__p49437781">HTTP Status Code</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0072__row45037339"><td class="cellrowborder" valign="top" width="39.795918367346935%" headers="mcps1.3.9.3.2.4.1.1 "><p id="obs_04_0072__p24145849">NoSuchWebsiteConfiguration</p>
</td>
<td class="cellrowborder" valign="top" width="35.714285714285715%" headers="mcps1.3.9.3.2.4.1.2 "><p id="obs_04_0072__p9656792">The website configuration does not exist.</p>
</td>
<td class="cellrowborder" valign="top" width="24.489795918367346%" headers="mcps1.3.9.3.2.4.1.3 "><p id="obs_04_0072__p44002720">404 Not Found</p>
</td>
</tr>
</tbody>
</table>
</div>
<p class="msonormal" id="obs_04_0072__p60480162">For other errors, see <a href="obs_04_0115.html#obs_04_0115__d0e843">Table 2</a>.</p>
</div>
<div class="section" id="obs_04_0072__section14482163815396"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="obs_04_0072__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>/?website<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>03:41:54<span class="w"> </span>GMT
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:Yxt1Ru+feHE0S94R7dcBp+hfLnI=
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0072__section76081155815"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="obs_04_0072__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></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>BF2600000164363442EC03A8CA3DD7F5
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSFbGOmlN0BVp1kbwN3har8jbVvtKEKN
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>03:41:54<span class="w"> </span>GMT
Content-Length:<span class="w"> </span>250
<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;WebsiteConfiguration</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="w"> </span><span class="nt">&lt;RedirectAllRequestsTo&gt;</span>
<span class="w"> </span><span class="nt">&lt;HostName&gt;</span>www.example.com<span class="nt">&lt;/HostName&gt;</span>
<span class="w"> </span><span class="nt">&lt;/RedirectAllRequestsTo&gt;</span>
<span class="nt">&lt;/WebsiteConfiguration&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_0070.html">Static Website Hosting</a></div>
</div>
</div>