doc-exports/docs/obs/s3api/en-us_topic_0000001168067883.html
zhangyue 14f2171339 OBS S3 API DOC
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-02-17 08:06:45 +00:00

111 lines
8.3 KiB
HTML

<a name="EN-US_TOPIC_0000001168067883"></a><a name="EN-US_TOPIC_0000001168067883"></a>
<h1 class="topictitle1">PUT Bucket Custom Domain</h1>
<div id="body0000001168067883"><p id="EN-US_TOPIC_0000001168067883__p52777375515">OBS uses the PUT method to configure a custom domain name for a bucket. After the configuration is successful, you can access the bucket through the domain name.</p>
<p id="EN-US_TOPIC_0000001168067883__p495617724216">Ensure that the custom domain name can correctly resolve to the OBS service through DNS.</p>
<div class="section" id="EN-US_TOPIC_0000001168067883__section57518732"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001168067883__screen175419175810"><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>PUT<span class="w"> </span>/?customdomain=domainname<span class="w"> </span>HTTP/1.1
User-Agent:<span class="w"> </span>curl/7.29.0
Host:<span class="w"> </span>bucketname.obs.region.example.com
Accept:<span class="w"> </span>*/*
Date:<span class="w"> </span>date
Authorization:<span class="w"> </span>authorization<span class="w"> </span>string
Content-Length:<span class="w"> </span>0
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001168067883__section47906541"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001168067883__table34931235193212" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001168067883__row195001352328"><th align="left" class="cellrowborder" valign="top" width="22.430000000000003%" id="mcps1.3.4.2.2.4.1.1"><p id="EN-US_TOPIC_0000001168067883__p750214358321">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.260000000000005%" id="mcps1.3.4.2.2.4.1.2"><p id="EN-US_TOPIC_0000001168067883__p95049355327">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.310000000000002%" id="mcps1.3.4.2.2.4.1.3"><p id="EN-US_TOPIC_0000001168067883__p185061235143215">Mandatory</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001168067883__row175081135133212"><td class="cellrowborder" valign="top" width="22.430000000000003%" headers="mcps1.3.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001168067883__p19510123510324">customdomain</p>
</td>
<td class="cellrowborder" valign="top" width="53.260000000000005%" headers="mcps1.3.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001168067883__p16551024153319">Custom domain name of a bucket.</p>
<p id="EN-US_TOPIC_0000001168067883__p3653204810576">Type: string, which must meet the naming convention of domain names.</p>
<p id="EN-US_TOPIC_0000001168067883__p154809270334">Specifications: The value contains a maximum of 256 characters.</p>
<p id="EN-US_TOPIC_0000001168067883__p163341526203219">No default value.</p>
<p id="EN-US_TOPIC_0000001168067883__p1557415131589">Constraints: A bucket can have a maximum of five domain names. A custom domain name can be used for only one bucket.</p>
</td>
<td class="cellrowborder" valign="top" width="24.310000000000002%" headers="mcps1.3.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001168067883__p853293516321">Yes</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001168067883__section28505693"><h4 class="sectiontitle">Request Headers</h4><p class="msonormal" id="EN-US_TOPIC_0000001168067883__p30785969">This request uses common headers. For details about common request headers, see the section <a href="en-us_topic_0125560462.html">Common Request Headers</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001168067883__section55224652"><h4 class="sectiontitle">Request Elements</h4><p id="EN-US_TOPIC_0000001168067883__p14712327152610">This request involves no elements.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001168067883__section46270551"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001168067883__screen065719411711"><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>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>request<span class="w"> </span>id
x-amz-id-2:<span class="w"> </span>id
Date:<span class="w"> </span>date
Content-Length:<span class="w"> </span>0
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001168067883__section13781782"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="EN-US_TOPIC_0000001168067883__p4179377">This response uses common headers. For details about common response headers, see the section <a href="en-us_topic_0125560484.html">Common Response Headers</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001168067883__section56927182"><h4 class="sectiontitle">Response Elements</h4><p id="EN-US_TOPIC_0000001168067883__p2025715391222">This response involves no elements.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001168067883__section42582590"><h4 class="sectiontitle">Error Responses</h4><p id="EN-US_TOPIC_0000001168067883__p2085119481221">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_0000001168067883__section32323009"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001168067883__screen11617610142118"><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>PUT<span class="w"> </span>/?customdomain=obs.ccc.com<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>Mon,<span class="w"> </span>14<span class="w"> </span>Jan<span class="w"> </span>2019<span class="w"> </span>08:31:36<span class="w"> </span>+0000
Authorization:<span class="w"> </span>AWS<span class="w"> </span>UDSIAMSTUBTEST000094:u2kJF4kENs6KlIDcAZpAKSKPtnc=
Content-Length:<span class="w"> </span>0
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001168067883__section22471632"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001168067883__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></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>000001697692CC5380E9D272E6D8F830
x-amz-id-2:<span class="w"> </span>32AAAQAAEAABSAAgAAEAABAAAQAAEAABCSsfu2GXj9gScHhFnrrTPY2cFOEZuvta
Date:<span class="w"> </span>Wed,<span class="w"> </span>13<span class="w"> </span>Mar<span class="w"> </span>2019<span class="w"> </span>10:22:05<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="en-us_topic_0125560493.html">Operations on Buckets</a></div>
</div>
</div>