vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/obs/api-ref/obs_04_0021.html
zhangyue 7d2a7ec198 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-11-05 16:37:11 +00:00

434 lines
41 KiB
HTML
Raw Blame History

<a name="obs_04_0021"></a><a name="obs_04_0021"></a>
<h1 class="topictitle1">Creating a Bucket</h1>
<div id="body39144302"><div class="section" id="obs_04_0021__section5584184924715"><h4 class="sectiontitle">Functions</h4><p class="MsoNormal" id="obs_04_0021__p35349457">This operation is used to create a bucket with a specified name.</p>
<div class="note" id="obs_04_0021__note49709663"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="obs_04_0021__ul84544338518"><li class="NotesText" id="obs_04_0021__li84548333513">By default, a user can have a maximum of 100 buckets.</li><li id="obs_04_0021__li1522184015116">The name of a deleted bucket can be reused for a bucket or a parallel file system at least 30 minutes after the deletion.</li><li id="obs_04_0021__li1531317173514">You can enable WORM when you create a bucket, but you cannot enable WORM for an existing bucket. In a bucket with WORM enabled, you can further configure retention policies for objects you upload to this bucket. For more information, see <a href="obs_04_0167.html">Configuring a Default WORM Policy for a Bucket</a>. Once enabled, WORM cannot be disabled for a bucket. When you create a bucket with WORM enabled, OBS automatically enables versioning for the bucket and the versioning cannot be suspended for that bucket. When you create a parallel file system, you cannot enable WORM for it.</li></ul>
</div></div>
<p class="MsoNormal" id="obs_04_0021__p179081185526">A bucket name must be unique in OBS. If a user creates a bucket with the same name as that of an existing bucket under the same account and in the same region, a 200 code (indicating success) is returned. In scenarios other than the preceding one, the request for creating a bucket with the same name as that of an existing one will receive the 409 code (indicating that a namesake bucket already exists). To set an access control policy for the bucket to be created, you can add the <strong id="obs_04_0021__b9296141924716">x-obs-acl</strong> parameter to request headers.</p>
</div>
<div class="section" id="obs_04_0021__section63129189"><h4 class="sectiontitle">Storage Class</h4><p id="obs_04_0021__p1459963215332">You can create buckets with different storage classes. The <strong id="obs_04_0021__b184051333135110">x-obs-storage-class</strong> header in a bucket creation request specifies the bucket's storage class. If you do not specify a storage class when you upload an object to the bucket, the object inherits the storage class of the bucket. The storage class options are as follows: <strong id="obs_04_0021__b1784703514308">STANDARD</strong> (Standard), <strong id="obs_04_0021__b331164816305">WARM</strong> (Warm), <strong id="obs_04_0021__b146151563117">COLD</strong> (Cold). If the <strong id="obs_04_0021__b1819518563534">x-obs-storage-class</strong> header is not in the request, a Standard bucket will be created.</p>
<p class="MsoNormal" id="obs_04_0021__p148955">If the storage class of an object is not specified when it is uploaded to a bucket (see <a href="obs_04_0080.html">Uploading an Object - PUT</a>), the object will be stored in the default storage class of the bucket.</p>
<ul id="obs_04_0021__ul12065374"><li id="obs_04_0021__li41479503">OBS Standard features low access latency and high throughput. It is most suitable for storing frequently accessed (multiple times per month) hot files. Potential application scenarios include big data, mobile applications, trending videos, and social media images.</li><li id="obs_04_0021__li13303135113346">OBS Warm storage class is suitable for storing data that is infrequently accessed (less than 12 times a year) yet has quick response requirements. Potential application scenarios include file synchronization or sharing and enterprise backup. It provides the same durability, access latency, and throughput as the Standard storage class but at a lower price. However, the Warm storage class has lower availability than the Standard one.</li><li id="obs_04_0021__li16303751123411">OBS Cold storage class is applicable to archiving rarely-accessed (averagely once a year) data. The application scenarios include data archiving and long-term data retention for backup. The Cold storage class is secure, durable, and inexpensive, which can replace tape libraries. However, the low cost comes at the cost of minutes to hours needed to restore data from the Cold storage class.</li></ul>
</div>
<div class="section" id="obs_04_0021__section31291796"><h4 class="sectiontitle">Request Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0021__screen20577521"><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></pre></div></td><td class="code"><div><pre><span></span>PUT<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
Content-Length:<span class="w"> </span>length
Date:<span class="w"> </span>date
Authorization:<span class="w"> </span>authorization
<span class="w"> </span>
<span class="nt">&lt;CreateBucketConfiguration</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="nt">&lt;Location&gt;</span>location<span class="nt">&lt;/Location&gt;</span><span class="w"> </span>
<span class="nt">&lt;/CreateBucketConfiguration&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0021__section13190716"><h4 class="sectiontitle">Request Parameters</h4><p class="MsoNormal" id="obs_04_0021__p31433398">This request contains no parameters.</p>
</div>
<div class="section" id="obs_04_0021__section51607580"><h4 class="sectiontitle">Request Headers</h4><p class="MsoNormal" id="obs_04_0021__p63077327">The operation message header is the same as that of a common request. For details, see <a href="obs_04_0007.html#obs_04_0007__table25197309">Table 3</a>. However, this request can contain additional headers. The following table describes the additional headers for this request.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0021__table1042132844215" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Additional request headers</caption><thead align="left"><tr id="obs_04_0021__row204312804217"><th align="left" class="cellrowborder" valign="top" width="14.030000000000001%" id="mcps1.3.5.3.2.5.1.1"><p id="obs_04_0021__p59834015"><strong id="obs_04_0021__b63317207406">Header</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.31%" id="mcps1.3.5.3.2.5.1.2"><p id="obs_04_0021__p14717055"><strong id="obs_04_0021__b734814409219">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.360000000000001%" id="mcps1.3.5.3.2.5.1.3"><p id="obs_04_0021__p584613535308"><strong id="obs_04_0021__b532092683010">Mandatory (Yes/No)</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.3%" id="mcps1.3.5.3.2.5.1.4"><p id="obs_04_0021__p19151453201618"><strong id="obs_04_0021__b1234604528">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0021__row6438283428"><td class="cellrowborder" valign="top" width="14.030000000000001%" headers="mcps1.3.5.3.2.5.1.1 "><p id="obs_04_0021__p134382812427">x-obs-acl</p>
</td>
<td class="cellrowborder" valign="top" width="12.31%" headers="mcps1.3.5.3.2.5.1.2 "><p id="obs_04_0021__p837352975019">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.5.3.2.5.1.3 "><p id="obs_04_0021__p243142874214">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.3%" headers="mcps1.3.5.3.2.5.1.4 "><p id="obs_04_0021__p118391720446"><strong id="obs_04_0021__b4952190683754">Explanation</strong>:</p>
<p id="obs_04_0021__p61848174444">When creating a bucket, you can use this parameter to set a pre-defined ACL.</p>
<p id="obs_04_0021__p14184217104420"><strong id="obs_04_0021__b55454341584028">Value range</strong>:</p>
<ul id="obs_04_0021__ul2242171412353"><li id="obs_04_0021__li8711166193815">private: A bucket or an object can be accessed only by its owner.</li><li id="obs_04_0021__li8242151415353">public-read: If this permission is granted on a bucket, anyone can read the object list, multipart uploads, and bucket metadata.</li><li id="obs_04_0021__li424291411357">public-read-write: If this permission is granted on a bucket, anyone can obtain the object list, multipart tasks, and metadata, and can upload or delete objects, initiate multipart upload tasks, upload parts, assemble parts, copy parts, and cancel multipart upload tasks.</li><li id="obs_04_0021__li1724391493515">public-read-delivered: If this permission is set for a bucket, everyone can obtain the object list, multipart uploads, and bucket metadata in the bucket, and obtain the content and metadata of the objects in the bucket.</li><li id="obs_04_0021__li52436142354">public-read-write-delivered: If this permission is set for a bucket, everyone can obtain the object list in the bucket, multipart uploads in the bucket, and metadata of the bucket; upload and delete objects; initiate multipart uploads; upload, assemble, and copy parts; cancel multipart uploads; and obtain content and metadata of objects in the bucket.</li><li id="obs_04_0021__li7243161413350">bucket-owner-full-control: If this permission is granted on an object, only the bucket and object owners have the full control over the object.<p id="obs_04_0021__p8652112483316"><a name="obs_04_0021__li7243161413350"></a><a name="li7243161413350"></a>By default, if you upload an object to a bucket of any other user, the bucket owner does not have the permissions on your object. After you grant this policy to the bucket owner, the bucket owner can have full control over your object.</p>
<p id="obs_04_0021__p4652624123313">For example, if user A uploads object <strong id="obs_04_0021__b63966241503">x</strong> to user B's bucket, user B does not have the control over object <strong id="obs_04_0021__b121091344165012">x</strong>. If user A sets the <strong id="obs_04_0021__b1891212665113">bucket-owner-full-control</strong> policy for object <strong id="obs_04_0021__b17901687516">x</strong>, user B then has the control over object <strong id="obs_04_0021__b668122213515">x</strong>.</p>
</li></ul>
<p id="obs_04_0021__p1418431784417"><strong id="obs_04_0021__b906137084121">Default value</strong>:</p>
<p id="obs_04_0021__p618415171441">private</p>
</td>
</tr>
<tr id="obs_04_0021__row94342864216"><td class="cellrowborder" valign="top" width="14.030000000000001%" headers="mcps1.3.5.3.2.5.1.1 "><p id="obs_04_0021__p1731615143488">x-obs-storage-class</p>
</td>
<td class="cellrowborder" valign="top" width="12.31%" headers="mcps1.3.5.3.2.5.1.2 "><p id="obs_04_0021__p171095244488">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.5.3.2.5.1.3 "><p id="obs_04_0021__p73171914104814">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.3%" headers="mcps1.3.5.3.2.5.1.4 "><p id="obs_04_0021__p4277941144817"><strong id="obs_04_0021__b178492939183754">Explanation</strong>:</p>
<p id="obs_04_0021__p1989454113453">When creating a bucket, you can add this header to set the default storage class for the bucket.</p>
<p id="obs_04_0021__p43471210498"><strong id="obs_04_0021__b20908789684028">Value range</strong>:</p>
<ul id="obs_04_0021__ul10861173765414"><li id="obs_04_0021__li1861123725420">STANDARD (Standard storage)</li><li id="obs_04_0021__li108621378547">WARM (Warm storage)</li><li id="obs_04_0021__li1586273712548">COLD (Cold storage)</li></ul>
<p id="obs_04_0021__p9427999496"><strong id="obs_04_0021__b204740548884121">Default value</strong>:</p>
<p id="obs_04_0021__p20317114144817">STANDARD</p>
</td>
</tr>
<tr id="obs_04_0021__row844182812429"><td class="cellrowborder" valign="top" width="14.030000000000001%" headers="mcps1.3.5.3.2.5.1.1 "><p id="obs_04_0021__p16815844205215">x-obs-grant-read</p>
</td>
<td class="cellrowborder" valign="top" width="12.31%" headers="mcps1.3.5.3.2.5.1.2 "><p id="obs_04_0021__p64422844212">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.5.3.2.5.1.3 "><p id="obs_04_0021__p1329515118527">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.3%" headers="mcps1.3.5.3.2.5.1.4 "><p id="obs_04_0021__p1941051714185"><strong id="obs_04_0021__b119227681783754">Explanation</strong>:</p>
<p id="obs_04_0021__p378416025311">Grants the read permission to all users in a specified domain. It allows you to list objects in a bucket, list multipart tasks in a bucket, list multi-version objects in a bucket, and obtain bucket metadata.</p>
<p id="obs_04_0021__p67841904539">Example: <strong id="obs_04_0021__b14242131312313">x-obs-grant-read:id=</strong><em id="obs_04_0021__i19242151353117">tenant-ID</em></p>
<p id="obs_04_0021__p0410121720183"><strong id="obs_04_0021__b569516193">Restrictions</strong>:</p>
<p id="obs_04_0021__p26021255354">None</p>
<p id="obs_04_0021__p15410111771813"><strong id="obs_04_0021__b143253049884028">Value range</strong>:</p>
<p id="obs_04_0021__p148370382441">id=<em id="obs_04_0021__i539123425710">tenant-ID</em>. For details, see <a href="obs_04_0117.html">Obtaining a Domain ID and a User ID</a>.</p>
<p id="obs_04_0021__p164101317151816"><strong id="obs_04_0021__b155987974884121">Default value</strong>:</p>
<p id="obs_04_0021__p57112264171">None</p>
</td>
</tr>
<tr id="obs_04_0021__row124452816424"><td class="cellrowborder" valign="top" width="14.030000000000001%" headers="mcps1.3.5.3.2.5.1.1 "><p id="obs_04_0021__p6815114411521">x-obs-grant-write</p>
</td>
<td class="cellrowborder" valign="top" width="12.31%" headers="mcps1.3.5.3.2.5.1.2 "><p id="obs_04_0021__p11447285427">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.5.3.2.5.1.3 "><p id="obs_04_0021__p132951711105215">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.3%" headers="mcps1.3.5.3.2.5.1.4 "><p id="obs_04_0021__p5178112021814"><strong id="obs_04_0021__b188275293783754">Explanation</strong>:</p>
<p id="obs_04_0021__p67841204531">Grants the WRITE permission to all users in a specified domain to create, delete, and overwrite all objects in a bucket; and initiate multipart uploads, upload parts, copy parts, assemble parts, and cancel multipart uploads.</p>
<p id="obs_04_0021__p12784402537">Example: <strong id="obs_04_0021__b1535122416314">x-obs-grant-write:id=</strong><em id="obs_04_0021__i1953515249318">tenant-ID</em></p>
<p id="obs_04_0021__p121111736162510"><strong id="obs_04_0021__b548172638">Restrictions</strong>:</p>
<p id="obs_04_0021__p14324353161211">None</p>
<p id="obs_04_0021__p1711243682510"><strong id="obs_04_0021__b1485322623">Value range</strong>:</p>
<p id="obs_04_0021__p18112123612512">id=<em id="obs_04_0021__i19955165945915">tenant-ID</em>. For details, see <a href="obs_04_0117.html">Obtaining a Domain ID and a User ID</a>.</p>
<p id="obs_04_0021__p01120368257"><strong id="obs_04_0021__b1282337564">Default value</strong>:</p>
<p id="obs_04_0021__p171121436102512">None</p>
</td>
</tr>
<tr id="obs_04_0021__row5150114915011"><td class="cellrowborder" valign="top" width="14.030000000000001%" headers="mcps1.3.5.3.2.5.1.1 "><p id="obs_04_0021__p581574495213">x-obs-grant-read-acp</p>
</td>
<td class="cellrowborder" valign="top" width="12.31%" headers="mcps1.3.5.3.2.5.1.2 "><p id="obs_04_0021__p121514497502">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.5.3.2.5.1.3 "><p id="obs_04_0021__p1829511125210">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.3%" headers="mcps1.3.5.3.2.5.1.4 "><p id="obs_04_0021__p2344265181"><strong id="obs_04_0021__b7592238883754">Explanation</strong>:</p>
<p id="obs_04_0021__p87855035312">Grant the READ_ACP permission to all users in a specified domain to allow them to read the bucket ACL.</p>
<p id="obs_04_0021__p1278511014539">Example: <strong id="obs_04_0021__b457272185">x-obs-grant-read-acp:id=</strong><em id="obs_04_0021__i1965001921">Account ID</em></p>
<p id="obs_04_0021__p8803193982520"><strong id="obs_04_0021__b781088541">Restrictions</strong>:</p>
<p id="obs_04_0021__p131134569123">None</p>
<p id="obs_04_0021__p1580333914253"><strong id="obs_04_0021__b266032509">Value range</strong>:</p>
<p id="obs_04_0021__p178031839152518">id=<em id="obs_04_0021__i1563722617017">tenant-ID</em>. For details, see <a href="obs_04_0117.html">Obtaining a Domain ID and a User ID</a>.</p>
<p id="obs_04_0021__p1480333911252"><strong id="obs_04_0021__b887670583">Default value</strong>:</p>
<p id="obs_04_0021__p08032396251">None</p>
</td>
</tr>
<tr id="obs_04_0021__row31511649105011"><td class="cellrowborder" valign="top" width="14.030000000000001%" headers="mcps1.3.5.3.2.5.1.1 "><p id="obs_04_0021__p98151944105213">x-obs-grant-write-acp</p>
</td>
<td class="cellrowborder" valign="top" width="12.31%" headers="mcps1.3.5.3.2.5.1.2 "><p id="obs_04_0021__p1965013868">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.5.3.2.5.1.3 "><p id="obs_04_0021__p142955111525">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.3%" headers="mcps1.3.5.3.2.5.1.4 "><p id="obs_04_0021__p77711928171820"><strong id="obs_04_0021__b37464234783754">Explanation</strong>:</p>
<p id="obs_04_0021__p27852017533">Grants the WRITE_ACP permission to all users in a specified domain to allow them to modify the bucket ACL.</p>
<p id="obs_04_0021__p47851302538">Example: <strong id="obs_04_0021__b637397175">x-obs-grant-write-acp:id=</strong><em id="obs_04_0021__i1839031782">Account ID</em></p>
<p id="obs_04_0021__p36326448254"><strong id="obs_04_0021__b1667795128">Restrictions</strong>:</p>
<p id="obs_04_0021__p6592145811217">None</p>
<p id="obs_04_0021__p1632184472520"><strong id="obs_04_0021__b1089683538">Value range</strong>:</p>
<p id="obs_04_0021__p76324445257">id=<em id="obs_04_0021__i1197412015112">tenant-ID</em>. For details, see <a href="obs_04_0117.html">Obtaining a Domain ID and a User ID</a>.</p>
<p id="obs_04_0021__p66323441257"><strong id="obs_04_0021__b1714433159">Default value</strong>:</p>
<p id="obs_04_0021__p1563214447252">None</p>
</td>
</tr>
<tr id="obs_04_0021__row15881552195020"><td class="cellrowborder" valign="top" width="14.030000000000001%" headers="mcps1.3.5.3.2.5.1.1 "><p id="obs_04_0021__p581519440529">x-obs-grant-full-control</p>
</td>
<td class="cellrowborder" valign="top" width="12.31%" headers="mcps1.3.5.3.2.5.1.2 "><p id="obs_04_0021__p5334201318611">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.5.3.2.5.1.3 "><p id="obs_04_0021__p12295161110520">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.3%" headers="mcps1.3.5.3.2.5.1.4 "><p id="obs_04_0021__p52561933201813"><strong id="obs_04_0021__b55233727883754">Explanation</strong>:</p>
<p id="obs_04_0021__p87861106537">Grants the FULL_CONTROL permission to all users in a specified domain.</p>
<p id="obs_04_0021__p97861809533">Example: <strong id="obs_04_0021__b93811152193120">x-obs-grant-full-control:id=</strong><em id="obs_04_0021__i03811452183110">tenant-ID</em></p>
<p id="obs_04_0021__p1323620496257"><strong id="obs_04_0021__b1151705629">Restrictions</strong>:</p>
<p id="obs_04_0021__p151521727135">None</p>
<p id="obs_04_0021__p16237049202517"><strong id="obs_04_0021__b1680983568">Value range</strong>:</p>
<p id="obs_04_0021__p2237104922511">id=<em id="obs_04_0021__i166281422110">tenant-ID</em>. For details, see <a href="obs_04_0117.html">Obtaining a Domain ID and a User ID</a>.</p>
<p id="obs_04_0021__p10237154917254"><strong id="obs_04_0021__b340534198">Default value</strong>:</p>
<p id="obs_04_0021__p1523784992516">None</p>
</td>
</tr>
<tr id="obs_04_0021__row9881852105013"><td class="cellrowborder" valign="top" width="14.030000000000001%" headers="mcps1.3.5.3.2.5.1.1 "><p id="obs_04_0021__p3815174475213">x-obs-grant-read-delivered</p>
</td>
<td class="cellrowborder" valign="top" width="12.31%" headers="mcps1.3.5.3.2.5.1.2 "><p id="obs_04_0021__p138811952175016">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.5.3.2.5.1.3 "><p id="obs_04_0021__p1329511118521">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.3%" headers="mcps1.3.5.3.2.5.1.4 "><p id="obs_04_0021__p11229204781814"><strong id="obs_04_0021__b75958566283754">Explanation</strong>:</p>
<p id="obs_04_0021__p8786140135314">Grants the READ permission to all users in a specified domain. By default, the read permission is granted on all objects in the bucket.</p>
<p id="obs_04_0021__p378618035311">Example: <strong id="obs_04_0021__b7485135743114">x-obs-grant-read-delivered:id=</strong><em id="obs_04_0021__i548545703117">tenant-ID</em></p>
<p id="obs_04_0021__p220415782514"><strong id="obs_04_0021__b676619329">Restrictions</strong>:</p>
<p id="obs_04_0021__p121022615136">None</p>
<p id="obs_04_0021__p18204257112510"><strong id="obs_04_0021__b38658521511">Value range</strong>:</p>
<p id="obs_04_0021__p122044573254">id=<em id="obs_04_0021__i15411617232">tenant-ID</em>. For details, see <a href="obs_04_0117.html">Obtaining a Domain ID and a User ID</a>.</p>
<p id="obs_04_0021__p4204155712254"><strong id="obs_04_0021__b1061185624">Default value</strong>:</p>
<p id="obs_04_0021__p1720485719253">None</p>
</td>
</tr>
<tr id="obs_04_0021__row1388145235012"><td class="cellrowborder" valign="top" width="14.030000000000001%" headers="mcps1.3.5.3.2.5.1.1 "><p id="obs_04_0021__p18815104495212">x-obs-grant-full-control-delivered</p>
</td>
<td class="cellrowborder" valign="top" width="12.31%" headers="mcps1.3.5.3.2.5.1.2 "><p id="obs_04_0021__p5881552195013">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.5.3.2.5.1.3 "><p id="obs_04_0021__p129531175217">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.3%" headers="mcps1.3.5.3.2.5.1.4 "><p id="obs_04_0021__p15891558111816"><strong id="obs_04_0021__b128007489183754">Explanation</strong>:</p>
<p id="obs_04_0021__p1878618085319">Grants the FULL_CONTROL permission to all users in a specified domain. By default, the FULL_CONTROL permission is granted on all objects in the bucket.</p>
<p id="obs_04_0021__p87864011539">Example: <strong id="obs_04_0021__b1481115320329">x-obs-grant-full-control-delivered:id=</strong><em id="obs_04_0021__i18811532327">tenant-ID</em></p>
<p id="obs_04_0021__p8213202264"><strong id="obs_04_0021__b1056698550">Restrictions</strong>:</p>
<p id="obs_04_0021__p13213190142619">None</p>
<p id="obs_04_0021__p1721314017266"><strong id="obs_04_0021__b287215321">Value range</strong>:</p>
<p id="obs_04_0021__p9213702266">id=<em id="obs_04_0021__i118824111242">tenant-ID</em>. For details, see <a href="obs_04_0117.html">Obtaining a Domain ID and a User ID</a>.</p>
<p id="obs_04_0021__p18213190192615"><strong id="obs_04_0021__b657450147">Default value</strong>:</p>
<p id="obs_04_0021__p112134042611">None</p>
</td>
</tr>
<tr id="obs_04_0021__row74431056175015"><td class="cellrowborder" valign="top" width="14.030000000000001%" headers="mcps1.3.5.3.2.5.1.1 "><p id="obs_04_0021__p081674414522">x-obs-fs-file-interface</p>
</td>
<td class="cellrowborder" valign="top" width="12.31%" headers="mcps1.3.5.3.2.5.1.2 "><p id="obs_04_0021__p19443175635013">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.5.3.2.5.1.3 "><p id="obs_04_0021__p17295111115522">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.3%" headers="mcps1.3.5.3.2.5.1.4 "><p id="obs_04_0021__p209537381913"><strong id="obs_04_0021__b207220076783754">Explanation</strong>:</p>
<p id="obs_04_0021__p1078640105315">This header can be carried when you want to create a parallel file system.</p>
<p id="obs_04_0021__p7786305536">Example: <strong id="obs_04_0021__b1116698855">x-obs-fs-file-interface:Enabled</strong></p>
<p id="obs_04_0021__p24321555171718"><strong id="obs_04_0021__b337313233220">Value range</strong>:</p>
<p id="obs_04_0021__p2667162517280">Enabled</p>
<p id="obs_04_0021__p18433755181719"><strong id="obs_04_0021__b191811834123219">Default value</strong>:</p>
<p id="obs_04_0021__p1255223822812">If the header is specified, the value must be <strong id="obs_04_0021__b589194213717">Enabled</strong>. There is no default value.</p>
</td>
</tr>
<tr id="obs_04_0021__row3444155675018"><td class="cellrowborder" valign="top" width="14.030000000000001%" headers="mcps1.3.5.3.2.5.1.1 "><p id="obs_04_0021__p18816144411523">x-obs-bucket-object-lock-enabled</p>
</td>
<td class="cellrowborder" valign="top" width="12.31%" headers="mcps1.3.5.3.2.5.1.2 "><p id="obs_04_0021__p44442565500">String</p>
</td>
<td class="cellrowborder" valign="top" width="11.360000000000001%" headers="mcps1.3.5.3.2.5.1.3 "><p id="obs_04_0021__p129691118525">No</p>
</td>
<td class="cellrowborder" valign="top" width="62.3%" headers="mcps1.3.5.3.2.5.1.4 "><p id="obs_04_0021__p206041735191919"><strong id="obs_04_0021__b140616239783754">Explanation</strong>:</p>
<p id="obs_04_0021__p678718018535">When creating a bucket, you can use this header to enable WORM for the bucket.</p>
<p id="obs_04_0021__p1578716025317">Example: <strong id="obs_04_0021__b1292063619">x-obs-bucket-object-lock-enabled:true</strong></p>
<p id="obs_04_0021__p0272131915188"><strong id="obs_04_0021__b859992303313">Restrictions</strong>:</p>
<p id="obs_04_0021__p1722633254313">Only object buckets are supported.</p>
<p id="obs_04_0021__p11272191961817"><strong id="obs_04_0021__b678510241339">Value range</strong>:</p>
<p id="obs_04_0021__p2036345062515">true: WORM is enabled.</p>
<p id="obs_04_0021__p1027241917180"><strong id="obs_04_0021__b1406726103319">Default value</strong>:</p>
<p id="obs_04_0021__p15661650134315">If the header is specified, the value must be <strong id="obs_04_0021__b7106111812520">true</strong>. There is no default value. If the header is not specified, WORM is disabled.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0021__section61815038"><h4 class="sectiontitle">Request Elements</h4><p class="MsoNormal" id="obs_04_0021__p63378491">This request can use additional elements. For details about additional elements, see <a href="#obs_04_0021__table6162112655310">Table 2</a>.</p>
<div class="tablenoborder"><a name="obs_04_0021__table6162112655310"></a><a name="table6162112655310"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0021__table6162112655310" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Additional request elements</caption><thead align="left"><tr id="obs_04_0021__row416382615533"><th align="left" class="cellrowborder" valign="top" width="12.540000000000001%" id="mcps1.3.6.3.2.5.1.1"><p id="obs_04_0021__p1416322615538"><strong id="obs_04_0021__b1675780923">Element</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.62%" id="mcps1.3.6.3.2.5.1.2"><p id="obs_04_0021__p13163182695314"><strong id="obs_04_0021__b66593412716">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.590000000000002%" id="mcps1.3.6.3.2.5.1.3"><p id="obs_04_0021__p6163142685311"><strong id="obs_04_0021__b1824219624417">Mandatory (Yes/No)</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.25%" id="mcps1.3.6.3.2.5.1.4"><p id="obs_04_0021__p1016392611534"><strong id="obs_04_0021__b3253144119342">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="obs_04_0021__row116316268539"><td class="cellrowborder" valign="top" width="12.540000000000001%" headers="mcps1.3.6.3.2.5.1.1 "><p id="obs_04_0021__p112427815544">Location</p>
</td>
<td class="cellrowborder" valign="top" width="14.62%" headers="mcps1.3.6.3.2.5.1.2 "><p id="obs_04_0021__p04481052165315">String</p>
</td>
<td class="cellrowborder" valign="top" width="15.590000000000002%" headers="mcps1.3.6.3.2.5.1.3 "><p id="obs_04_0021__p16163172614536">No</p>
</td>
<td class="cellrowborder" valign="top" width="57.25%" headers="mcps1.3.6.3.2.5.1.4 "><p id="obs_04_0021__p7134184955020"><strong id="obs_04_0021__b155592107483754">Explanation</strong>:</p>
<p id="obs_04_0021__p11446552125319">Specifies the region where a bucket will be created.</p>
<ul id="obs_04_0021__ul544795220532"><li id="obs_04_0021__li13447175265311">When creating a bucket using the endpoint of the default region, note the following:<ul id="obs_04_0021__ul17447105212537"><li id="obs_04_0021__li7447135235314">If <strong id="obs_04_0021__b1852220769">Location</strong> is not specified, the bucket is created in the default region.</li><li id="obs_04_0021__li174471252165313">If Location is specified to other region, the bucket is created in the specified region.</li></ul>
</li><li id="obs_04_0021__li044713529531">When creating a bucket using the endpoint of a non-default region, <strong id="obs_04_0021__b135134488">Location</strong> must be specified to the region corresponding to the endpoint.</li></ul>
<p id="obs_04_0021__p1021015451247"><strong id="obs_04_0021__b2121563337">Restrictions</strong>:</p>
<p id="obs_04_0021__p79066401338">If the used endpoint is <strong id="obs_04_0021__b28942451818">obs.otc.t-systems.com</strong>, this parameter is not required. If any other endpoint is used, this parameter is required.</p>
<p id="obs_04_0021__p813444912504"><strong id="obs_04_0021__b58042797484028">Value range</strong>:</p>
<p id="obs_04_0021__p6447252145311">For details about OBS regions and endpoints, see <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
<p id="obs_04_0021__p158271314192512"><strong id="obs_04_0021__b25455721814">Default value</strong>:</p>
<p id="obs_04_0021__p1917544114016">If the endpoint is <strong id="obs_04_0021__b1673612562112">obs.otc.t-systems.com</strong> and no region is specified, the default value is <strong id="obs_04_0021__b1478419812113">eu-de</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_04_0021__section19464436"><h4 class="sectiontitle">Response Syntax</h4><div class="codecoloring" codetype="Xml" id="obs_04_0021__screen27167126"><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>HTTP/1.1<span class="w"> </span>status_code
Location:<span class="w"> </span>location
Date:<span class="w"> </span>date
Content-Length:<span class="w"> </span>length
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0021__section40962197"><h4 class="sectiontitle">Response Headers</h4><p class="msonormal" id="obs_04_0021__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_0021__section33115460"><h4 class="sectiontitle">Response Elements</h4><p class="MsoNormal" id="obs_04_0021__p31505145">This response contains no elements.</p>
</div>
<div class="section" id="obs_04_0021__section29603689"><h4 class="sectiontitle">Error Responses</h4><p class="MsoNormal" id="obs_04_0021__p1779922">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_0021__section4967514913"><h4 class="sectiontitle">Sample Request: Creating a Bucket</h4><div class="codecoloring" codetype="Xml" id="obs_04_0021__screen26315321216"><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></pre></div></td><td class="code"><div><pre><span></span>PUT<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:25:05<span class="w"> </span>GMT
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:75/Y4Ng1izvzc1nTGxpMXTE6ynw=
Content-Length:<span class="w"> </span>157
<span class="nt">&lt;CreateBucketConfiguration</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="nt">&lt;Location&gt;</span>region<span class="nt">&lt;/Location&gt;</span>
<span class="nt">&lt;/CreateBucketConfiguration&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0021__section61601145011"><h4 class="sectiontitle">Sample Response: Creating a Bucket</h4><div class="codecoloring" codetype="Xml" id="obs_04_0021__screen1263818017211"><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>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>BF260000016435CE298386946AE4C482
Location:<span class="w"> </span>/examplebucket
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABSAAgAAEAABAAAQAAEAABCT9W2tcvLmMJ+plfdopaD62S0npbaRUz
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:25:06<span class="w"> </span>GMT
Content-Length:<span class="w"> </span>0
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0021__section535111413214"><h4 class="sectiontitle">Sample Request: Creating a Bucket (with the ACL and Storage Class Specified)</h4><div class="codecoloring" codetype="Xml" id="obs_04_0021__screen12744828924"><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></pre></div></td><td class="code"><div><pre><span></span>PUT<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:25:05<span class="w"> </span>GMT
x-obs-acl:public-read
x-obs-storage-class:STANDARD
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:75/Y4Ng1izvzc1nTGxpMXTE6ynw=
Content-Length:<span class="w"> </span>157
<span class="nt">&lt;CreateBucketConfiguration</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="nt">&lt;Location&gt;</span>region<span class="nt">&lt;/Location&gt;</span><span class="w"> </span>
<span class="nt">&lt;/CreateBucketConfiguration&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0021__section01968196583"><h4 class="sectiontitle">Sample Response: Creating a Bucket (with the ACL and Storage Class Specified)</h4><div class="codecoloring" codetype="Xml" id="obs_04_0021__screen181998192587"><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>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>BF260000016435CE298386946AE4C482
Location:<span class="w"> </span>/examplebucket
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABSAAgAAEAABAAAQAAEAABCT9W2tcvLmMJ+plfdopaD62S0npbaRUz
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:25:06<span class="w"> </span>GMT
Content-Length:<span class="w"> </span>0
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0021__section4293341135610"><a name="obs_04_0021__section4293341135610"></a><a name="section4293341135610"></a><h4 class="sectiontitle">Sample Request: Creating a Parallel File System</h4><div class="codecoloring" codetype="Xml" id="obs_04_0021__screen152931411562"><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></pre></div></td><td class="code"><div><pre><span></span>PUT<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:25:05<span class="w"> </span>GMT
Authorization:<span class="w"> </span>OBS<span class="w"> </span>H4IPJX0TQTHTHEBQQCEC:75/Y4Ng1izvzc1nTGxpMXTE6ynw=
Content-Length:<span class="w"> </span>157
x-obs-fs-file-interface:<span class="w"> </span>Enabled
<span class="nt">&lt;CreateBucketConfiguration</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="nt">&lt;Location&gt;</span>region<span class="nt">&lt;/Location&gt;</span><span class="w"> </span>
<span class="nt">&lt;/CreateBucketConfiguration&gt;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0021__section8294241145618"><h4 class="sectiontitle">Sample Response: Creating a Parallel File System</h4><div class="codecoloring" codetype="Xml" id="obs_04_0021__screen32947410563"><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>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>BF260000016435CE298386946AE4C482
Location:<span class="w"> </span>/examplebucket
x-obs-id-2:<span class="w"> </span>32AAAQAAEAABSAAgAAEAABAAAQAAEAABCT9W2tcvLmMJ+plfdopaD62S0npbaRUz
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:25:06<span class="w"> </span>GMT
Content-Length:<span class="w"> </span>0
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="obs_04_0021__section62827378569"><h4 class="sectiontitle">Sample Request: Creating a Bucket with WORM Enabled</h4><pre class="screen" id="obs_04_0021__screen9331457195713">PUT / HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.example.com
Accept: */*
Date: WED, 01 Jul 2015 02:25:05 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:75/Y4Ng1izvzc1nTGxpMXTE6ynw=
x-obs-bucket-object-lock-enabled:true
Content-Length: 0</pre>
</div>
<div class="section" id="obs_04_0021__section21791905571"><h4 class="sectiontitle">Sample Response: Creating a Bucket with WORM Enabled</h4><pre class="screen" id="obs_04_0021__screen3134132318214">HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: 00000184C11AC7A6809F881341842C02
x-reserved-indicator: Unauthorized
Location: /examplebucket
x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCT9W2tcvLmMJ+plfdopaD62S0npbaRUz
Date: WED, 01 Jul 2015 02:25:06 GMT
Content-Length: 0</pre>
</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