vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/obs/s3api/en-us_topic_0000001168027913.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

162 lines
12 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001168027913"></a><a name="EN-US_TOPIC_0000001168027913"></a>
<h1 class="topictitle1">GET Bucket Custom Domain</h1>
<div id="body0000001168027913"><p id="EN-US_TOPIC_0000001168027913__p8060118">OBS uses the GET method to obtain the custom domain name of a bucket.</p>
<div class="section" id="EN-US_TOPIC_0000001168027913__section57518732"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001168027913__screen740133832512"><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>/?customdomain<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
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001168027913__section47906541"><h4 class="sectiontitle">Request Parameters</h4><p id="EN-US_TOPIC_0000001168027913__p194119471237">This request contains no parameter.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001168027913__section28505693"><h4 class="sectiontitle">Request Headers</h4><p class="msonormal" id="EN-US_TOPIC_0000001168027913__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_0000001168027913__section55224652"><h4 class="sectiontitle">Request Elements</h4><p id="EN-US_TOPIC_0000001168027913__p1239212161841">This request involves no elements.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001168027913__section46270551"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001168027913__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>
<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></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
Content-Type:<span class="w"> </span>application/xml
Date:<span class="w"> </span>date
Content-Length:<span class="w"> </span>272
<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;ListBucketCustomDomainsResult</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;Domains&gt;</span>
<span class="w"> </span><span class="nt">&lt;DomainName&gt;</span>domainname<span class="nt">&lt;/DomainName&gt;</span>
<span class="w"> </span><span class="nt">&lt;CreateTime&gt;</span>createtime<span class="nt">&lt;/CreateTime&gt;</span>
<span class="w"> </span><span class="nt">&lt;/Domains&gt;</span>
<span class="nt">&lt;/ListBucketCustomDomainsResult&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001168027913__section13781782"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="EN-US_TOPIC_0000001168027913__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_0000001168027913__section56927182"><h4 class="sectiontitle">Response Elements</h4><p class="msonormal" id="EN-US_TOPIC_0000001168027913__p65060221">The response returns the custom domain name of the bucket in the form of message elements. <a href="#EN-US_TOPIC_0000001168027913__d0e8370">Table 1</a> lists details about each element.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001168027913__d0e8370"></a><a name="d0e8370"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001168027913__d0e8370" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Response elements</caption><thead align="left"><tr id="EN-US_TOPIC_0000001168027913__row7433603"><th align="left" class="cellrowborder" valign="top" width="39.39%" id="mcps1.3.8.3.2.3.1.1"><p id="EN-US_TOPIC_0000001168027913__p65251010">Element</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.61%" id="mcps1.3.8.3.2.3.1.2"><p id="EN-US_TOPIC_0000001168027913__p54911228">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001168027913__row33402770"><td class="cellrowborder" valign="top" width="39.39%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001168027913__p1178691844919">ListBucketCustomDomainsResult</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001168027913__p41737906">Container of the returned result</p>
<p id="EN-US_TOPIC_0000001168027913__p40096838">Type: container</p>
<p id="EN-US_TOPIC_0000001168027913__p25327227">Children: Domains</p>
<p id="EN-US_TOPIC_0000001168027913__p26618459">Ancestor: none</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001168027913__row32220038"><td class="cellrowborder" valign="top" width="39.39%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001168027913__p59686313">Domains</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001168027913__p2753164">Element indicating the custom domain name</p>
<p id="EN-US_TOPIC_0000001168027913__p24778477">Type: element</p>
<p id="EN-US_TOPIC_0000001168027913__p471612013534">Children: DomainName, CreateTime</p>
<p id="EN-US_TOPIC_0000001168027913__p1471632014532">Ancestor: ListBucketCustomDomainsResult</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001168027913__row20591764545"><td class="cellrowborder" valign="top" width="39.39%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001168027913__p65986115418">DomainName</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001168027913__p1135662819546">Custom domain name</p>
<p id="EN-US_TOPIC_0000001168027913__p835692865410">Type: string</p>
<p id="EN-US_TOPIC_0000001168027913__p9356182895417">Children: none</p>
<p id="EN-US_TOPIC_0000001168027913__p10356928175418">Ancestor: Domains</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001168027913__row05952215547"><td class="cellrowborder" valign="top" width="39.39%" headers="mcps1.3.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001168027913__p35952215545">CreateTime</p>
</td>
<td class="cellrowborder" valign="top" width="60.61%" headers="mcps1.3.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001168027913__p18296214205517">Time when a custom domain name is created</p>
<p id="EN-US_TOPIC_0000001168027913__p629610146551">Type: string, expressed in the form of UTC time.</p>
<p id="EN-US_TOPIC_0000001168027913__p1029613146550">Children: none</p>
<p id="EN-US_TOPIC_0000001168027913__p1929631455517">Ancestor: Domains</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001168027913__section42582590"><h4 class="sectiontitle">Error Responses</h4><p id="EN-US_TOPIC_0000001168027913__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_0000001168027913__section32323009"><h4 class="sectiontitle">Sample Request</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001168027913__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></pre></div></td><td class="code"><div><pre><span></span>GET<span class="w"> </span>/?customdomain<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:45<span class="w"> </span>+0000
Authorization:<span class="w"> </span>AWS<span class="w"> </span>UDSIAMSTUBTEST000094:veTm8B18MPLFqNyGh2wmQqovZ2U=
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001168027913__section22471632"><h4 class="sectiontitle">Sample Response</h4><div class="codecoloring" codetype="Xml" id="EN-US_TOPIC_0000001168027913__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></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>000001697693130C80E9D2D29FA84FC2
x-amz-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSM80AI9weqGUsIFJScVxSKlG4DmypX9
Content-Type:<span class="w"> </span>application/xml
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:24<span class="w"> </span>GMT
Content-Length:<span class="w"> </span>272
<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;ListBucketCustomDomainsResult</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;Domains&gt;</span>
<span class="w"> </span><span class="nt">&lt;DomainName&gt;</span>obs.ccc.com<span class="nt">&lt;/DomainName&gt;</span>
<span class="w"> </span><span class="nt">&lt;CreateTime&gt;</span>2019-03-13T10:22:05.912Z<span class="nt">&lt;/CreateTime&gt;</span>
<span class="w"> </span><span class="nt">&lt;/Domains&gt;</span>
<span class="nt">&lt;/ListBucketCustomDomainsResult&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>
View Git Blame Copy Permalink