vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/obs/api-ref/obs_04_0023.html
zhangyue 8ba86cabc9 OBS API DOC 
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-05-28 10:01:19 +00:00

231 lines
17 KiB
HTML
Raw Blame History

<a name="obs_04_0023"></a><a name="obs_04_0023"></a>
<h1 class="topictitle1">Obtaining Bucket Metadata</h1>
<div id="body25817766"><div class="section" id="obs_04_0023__section5584184924715"><h4 class="sectiontitle">Functions</h4><p id="obs_04_0023__p17535135114815">This operation queries the metadata of a bucket. To use this operation, you must have the permission to read the bucket.</p>
</div>
<div class="section" id="obs_04_0023__section18757290"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0023__screen10864297"><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>HEAD<span class="w"> </span>/<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_0023__section34597883"><h4 class="sectiontitle">Request Parameters</h4><p id="obs_04_0023__p42379299">This request contains no parameters.</p>
</div>
<div class="section" id="obs_04_0023__section42945494"><h4 class="sectiontitle">Request Headers</h4><p id="obs_04_0023__p10171172">This request uses common headers. For details, see <a href="obs_04_0007.html#obs_04_0007__table25197309">Table 3</a>.</p>
<p id="obs_04_0023__p79345353417"><a href="#obs_04_0023__table1147631064117">Table 1</a> lists the header fields required when obtaining CORS configuration information.</p>
<div class="tablenoborder"><a name="obs_04_0023__table1147631064117"></a><a name="table1147631064117"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0023__table1147631064117" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request headers for obtaining CORS configuration</caption><thead align="left"><tr id="obs_04_0023__row104762010184112"><th align="left" class="cellrowborder" valign="top" width="33.813381338133816%" id="mcps1.3.4.4.2.4.1.1"><p id="obs_04_0023__p3648121644115">Header</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.474547454745476%" id="mcps1.3.4.4.2.4.1.2"><p id="obs_04_0023__p06489167418">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.712071207120715%" id="mcps1.3.4.4.2.4.1.3"><p id="obs_04_0023__p15648116124115">Mandatory</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0023__row3476141084114"><td class="cellrowborder" valign="top" width="33.813381338133816%" headers="mcps1.3.4.4.2.4.1.1 "><p id="obs_04_0023__p1916372119415">Origin</p>
</td>
<td class="cellrowborder" valign="top" width="45.474547454745476%" headers="mcps1.3.4.4.2.4.1.2 "><p id="obs_04_0023__p18179621114115">Origin of the cross-domain request specified by the pre-request. Generally, it is a domain name.</p>
<p id="obs_04_0023__p14179162115413">Type: string</p>
</td>
<td class="cellrowborder" valign="top" width="20.712071207120715%" headers="mcps1.3.4.4.2.4.1.3 "><p id="obs_04_0023__p817915215419">Yes</p>
</td>
</tr>
<tr id="obs_04_0023__row747641034113"><td class="cellrowborder" valign="top" width="33.813381338133816%" headers="mcps1.3.4.4.2.4.1.1 "><p id="obs_04_0023__p136311624154111">Access-Control-Request-Headers</p>
</td>
<td class="cellrowborder" valign="top" width="45.474547454745476%" headers="mcps1.3.4.4.2.4.1.2 "><p id="obs_04_0023__p1563142418417">HTTP headers of a request. The request can use multiple HTTP headers.</p>
<p id="obs_04_0023__p56312242419">Type: string</p>
</td>
<td class="cellrowborder" valign="top" width="20.712071207120715%" headers="mcps1.3.4.4.2.4.1.3 "><p id="obs_04_0023__p1963111240416">No</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0023__section50965133"><h4 class="sectiontitle">Request Elements</h4><p id="obs_04_0023__p32809987">This request contains no elements.</p>
</div>
<div class="section" id="obs_04_0023__section56033015"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0023__screen40363275"><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
x-obs-bucket-location:<span class="w"> </span>region
Date:<span class="w"> </span>date
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0023__section34535095"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0023__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>
<p id="obs_04_0023__p34922606">In addition to the common response headers, the headers listed in <a href="#obs_04_0023__table13151171313444">Table 2</a> may be used.</p>
<div class="tablenoborder"><a name="obs_04_0023__table13151171313444"></a><a name="table13151171313444"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0023__table13151171313444" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Additional response headers</caption><thead align="left"><tr id="obs_04_0023__row815181319449"><th align="left" class="cellrowborder" valign="top" width="44.72%" id="mcps1.3.7.4.2.3.1.1"><p id="obs_04_0023__p357332011449">Header</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.279999999999994%" id="mcps1.3.7.4.2.3.1.2"><p id="obs_04_0023__p155736206445">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0023__row515115131447"><td class="cellrowborder" valign="top" width="44.72%" headers="mcps1.3.7.4.2.3.1.1 "><p id="obs_04_0023__p1268114419442">x-obs-bucket-location</p>
</td>
<td class="cellrowborder" valign="top" width="55.279999999999994%" headers="mcps1.3.7.4.2.3.1.2 "><p id="obs_04_0023__p13681154484410">The region where the bucket resides.</p>
<p id="obs_04_0023__p36817443443">Type: string</p>
</td>
</tr>
<tr id="obs_04_0023__row9151181314410"><td class="cellrowborder" valign="top" width="44.72%" headers="mcps1.3.7.4.2.3.1.1 "><p id="obs_04_0023__p6681144134416">x-obs-storage-class</p>
</td>
<td class="cellrowborder" valign="top" width="55.279999999999994%" headers="mcps1.3.7.4.2.3.1.2 "><p id="obs_04_0023__p222815391378">Default storage class of the bucket. The options are as follows: <strong id="obs_04_0023__b07232019123917">STANDARD</strong> (Standard), <strong id="obs_04_0023__b6655731153911">WARM</strong> (Warm), <strong id="obs_04_0023__b3267153763919">COLD</strong> (Cold).</p>
<p id="obs_04_0023__p86811444134410">Type: string</p>
</td>
</tr>
<tr id="obs_04_0023__row71511513164413"><td class="cellrowborder" valign="top" width="44.72%" headers="mcps1.3.7.4.2.3.1.1 "><p id="obs_04_0023__p1368134414416">x-obs-version</p>
</td>
<td class="cellrowborder" valign="top" width="55.279999999999994%" headers="mcps1.3.7.4.2.3.1.2 "><p id="obs_04_0023__p969674414418">OBS version of the bucket.</p>
<p id="obs_04_0023__p8696184412443">Type: string</p>
</td>
</tr>
<tr id="obs_04_0023__row16151113194412"><td class="cellrowborder" valign="top" width="44.72%" headers="mcps1.3.7.4.2.3.1.1 "><p id="obs_04_0023__p5696164415447">x-obs-fs-file-interface</p>
</td>
<td class="cellrowborder" valign="top" width="55.279999999999994%" headers="mcps1.3.7.4.2.3.1.2 "><p id="obs_04_0023__p94382063714">Indicates whether the bucket is a parallel file system. The value can be <strong id="obs_04_0023__b799019011311">Enabled</strong> (parallel file system).</p>
<p id="obs_04_0023__p1069654494411">If this header field is not carried, the bucket is not a parallel file system.</p>
<p id="obs_04_0023__p26968442444">Type: string</p>
</td>
</tr>
<tr id="obs_04_0023__row1615191316449"><td class="cellrowborder" valign="top" width="44.72%" headers="mcps1.3.7.4.2.3.1.1 "><p id="obs_04_0023__p655618544449">Access-Control-Allow-Origin</p>
</td>
<td class="cellrowborder" valign="top" width="55.279999999999994%" headers="mcps1.3.7.4.2.3.1.2 "><p id="obs_04_0023__p175569544442">Indicates that the origin is included in the response if the origin in the request meets the CORS configuration requirements when CORS is configured for buckets.</p>
<p id="obs_04_0023__p10556195454412">Type: string</p>
</td>
</tr>
<tr id="obs_04_0023__row9151171316448"><td class="cellrowborder" valign="top" width="44.72%" headers="mcps1.3.7.4.2.3.1.1 "><p id="obs_04_0023__p255615414444">Access-Control-Allow-Headers</p>
</td>
<td class="cellrowborder" valign="top" width="55.279999999999994%" headers="mcps1.3.7.4.2.3.1.2 "><p id="obs_04_0023__p15556145420440">Indicates that the headers are included in the response if headers in the request meet the CORS configuration requirements when CORS is configured for buckets.</p>
<p id="obs_04_0023__p1655615413446">Type: string</p>
</td>
</tr>
<tr id="obs_04_0023__row16151171314417"><td class="cellrowborder" valign="top" width="44.72%" headers="mcps1.3.7.4.2.3.1.1 "><p id="obs_04_0023__p7556165494410">Access-Control-Max-Age</p>
</td>
<td class="cellrowborder" valign="top" width="55.279999999999994%" headers="mcps1.3.7.4.2.3.1.2 "><p id="obs_04_0023__p1755625416449">Value of <strong id="obs_04_0023__b3651102347">MaxAgeSeconds</strong> in the CORS configuration of the server when CORS is configured for buckets.</p>
<p id="obs_04_0023__p45561954104411">Type: integer</p>
</td>
</tr>
<tr id="obs_04_0023__row815118139443"><td class="cellrowborder" valign="top" width="44.72%" headers="mcps1.3.7.4.2.3.1.1 "><p id="obs_04_0023__p1055625411443">Access-Control-Allow-Methods</p>
</td>
<td class="cellrowborder" valign="top" width="55.279999999999994%" headers="mcps1.3.7.4.2.3.1.2 "><p id="obs_04_0023__p0556105494415">Indicates that methods in the rule are included in the response if <strong id="obs_04_0023__b436181492320">Access-Control-Request-Method</strong> in the request meets the CORS configuration requirements when CORS is configured for buckets.</p>
<p id="obs_04_0023__p4556155444413">Type: string</p>
<p id="obs_04_0023__p0556105420445">Value options: <strong id="obs_04_0023__b3278848134815">GET</strong>, <strong id="obs_04_0023__b1127814811482">PUT</strong>, <strong id="obs_04_0023__b12278748124818">HEAD</strong>, <strong id="obs_04_0023__b0278348184818">POST</strong>, <strong id="obs_04_0023__b7279348104811">DELETE</strong></p>
</td>
</tr>
<tr id="obs_04_0023__row815121312444"><td class="cellrowborder" valign="top" width="44.72%" headers="mcps1.3.7.4.2.3.1.1 "><p id="obs_04_0023__p2556954194412">Access-Control-Expose-Headers</p>
</td>
<td class="cellrowborder" valign="top" width="55.279999999999994%" headers="mcps1.3.7.4.2.3.1.2 "><p id="obs_04_0023__p455605484418">Value of <strong id="obs_04_0023__b7102534">ExposeHeader</strong> in the CORS configuration of a server when CORS is configured for buckets.</p>
<p id="obs_04_0023__p7556145419441">Type: string</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0023__section42380405"><h4 class="sectiontitle">Response Elements</h4><p id="obs_04_0023__p43090167">This response contains no elements.</p>
</div>
<div class="section" id="obs_04_0023__section45879330"><h4 class="sectiontitle">Error Responses</h4><p id="obs_04_0023__p642611">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_0023__section14482163815396"><h4 class="sectiontitle">Sample Request: Getting CORS Configuration (with No Headers Specified)</h4><div class="codecoloring" codetype="Xml" id="obs_04_0023__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>HEAD<span class="w"> </span>/<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>02:30:25<span class="w"> </span>GMT
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:niCQCuGIZpETKIyx1datxHZyYlk=
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0023__section76081155815"><h4 class="sectiontitle">Sample Response: Getting CORS Configuration (with No Headers Specified)</h4><div class="codecoloring" codetype="Xml" id="obs_04_0023__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></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>BF260000016439C734E0788404623FA8
Content-Type:<span class="w"> </span>application/xml
x-obs-storage-class:<span class="w"> </span>STANDARD
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSxwLpq9Hzf3OnaXr+pI/OPLKdrtiQAF
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>02:30:25<span class="w"> </span>GMT
x-obs-bucket-location:<span class="w"> </span>region
x-obs-version:<span class="w"> </span>3.0
Content-Length:<span class="w"> </span>0
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0023__section061751194812"><h4 class="sectiontitle">Sample Request: Getting Bucket Metadata and CORS Configuration</h4><div class="codecoloring" codetype="Xml" id="obs_04_0023__screen1668910265501"><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></pre></div></td><td class="code"><div><pre><span></span>HEAD<span class="w"> </span>/<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>02:30:25<span class="w"> </span>GMT
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:niCQCuGIZpETKIyx1datxHZyYlk=
Origin:www.example.com
Access-Control-Request-Headers:AllowedHeader_1
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0023__section1985922615524"><h4 class="sectiontitle">Sample Response: Getting Bucket Metadata and CORS Configuration</h4><div class="codecoloring" codetype="Xml" id="obs_04_0023__screen1234312101531"><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-obs-request-id:<span class="w"> </span>BF260000016439C734E0788404623FA8
Content-Type:<span class="w"> </span>application/xml
x-obs-storage-class:<span class="w"> </span>STANDARD
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABAAAQAAEAABAAAQAAEAABCSxwLpq9Hzf3OnaXr+pI/OPLKdrtiQAF
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>02:30:25<span class="w"> </span>GMT
x-obs-bucket-location:<span class="w"> </span>region
Access-Control-Allow-Origin:<span class="w"> </span>www.example.com<span class="w"> </span>
Access-Control-Allow-Methods:<span class="w"> </span>POST,GET,HEAD,PUT<span class="w"> </span>
Access-Control-Allow-Headers:<span class="w"> </span>AllowedHeader_1<span class="w"> </span>
Access-Control-Max-Age:<span class="w"> </span>100<span class="w"> </span>
Access-Control-Expose-Headers:<span class="w"> </span>ExposeHeader_1<span class="w"> </span>
x-obs-version:<span class="w"> </span>3.0
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_0019.html">Operations on Buckets</a></div>
</div>
</div>
View Git Blame Copy Permalink