vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

Object Storage Service API Reference Swift V1

Browse Source 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
This commit is contained in:
zhangyue 2023-02-02 08:50:48 +00:00 committed by zuul
parent cfec39ba1b
commit 894279c39a
104 changed files with 7289 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

802
docs/obs/api-swift/ALL_META.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

722
docs/obs/api-swift/CLASS.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

3
docs/obs/api-swift/PARAMETERS.txt Normal file
View File

@ -0,0 +1,3 @@
version=""
language="en-us"
type=""

BIN
docs/obs/api-swift/en-us_image_0138437473.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.0 KiB

BIN
docs/obs/api-swift/en-us_image_0138437574.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.1 KiB

BIN
docs/obs/api-swift/en-us_image_0138437619.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.5 KiB

BIN
docs/obs/api-swift/en-us_image_0138437668.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.2 KiB

BIN
docs/obs/api-swift/en-us_image_0138437827.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.2 KiB

18
docs/obs/api-swift/obs_03_0001.html Normal file
View File

@ -0,0 +1,18 @@
<a name="obs_03_0001"></a><a name="obs_03_0001"></a>
<h1 class="topictitle1">Overview</h1>
<div id="body39451090"><p id="obs_03_0001__p19515494">This chapter describes the functions and REST application programming interfaces (APIs) supported by Object Storage Service (OBS), which is compatible with OpenStack Swift.</p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_03_0002.html">Functions</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0003.html">API Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0004.html">Concurrent Operation Consistency</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0005.html">Suggestions on Container Performance Tuning</a></strong><br>
</li>
</ul>
</div>

11
docs/obs/api-swift/obs_03_0002.html Normal file
View File

@ -0,0 +1,11 @@
<a name="obs_03_0002"></a><a name="obs_03_0002"></a>
<h1 class="topictitle1">Functions</h1>
<div id="body37251161"><p id="obs_03_0002__p16839763">OBS (compatible with OpenStack Swift) is provided based on simple web service APIs. OBS helps construct storage-based Internet applications such as web hosting as well as online video, photo albums, and backup applications. OBS (compatible with OpenStack Swift) provides REST APIs, allowing users to easily access OBS through web applications.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0001.html">Overview</a></div>
</div>
</div>

342
docs/obs/api-swift/obs_03_0003.html Normal file
View File

File diff suppressed because it is too large Load Diff

23
docs/obs/api-swift/obs_03_0004.html Normal file
View File

@ -0,0 +1,23 @@
<a name="obs_03_0004"></a><a name="obs_03_0004"></a>
<h1 class="topictitle1">Concurrent Operation Consistency</h1>
<div id="body1398743672213"><p id="obs_03_0004__p39303773153937">After a success message is returned in response to a client's write or deletion request, the client can obtain the latest data. If the client that initiated a write request times out while waiting for a response, or the server returns HTTP response status code 500 or 503, the subsequent read operations may fail. If such an error occurs, check whether the data was successfully uploaded to the server. If the data was not uploaded successfully, upload it again.</p>
<p id="obs_03_0004__p18189640153937">If multiple clients simultaneously upload, query, or delete the same object or container, these operations may reach the system at different points in time and experience different internal processing latency periods, and different results may be returned. For example, if multiple clients simultaneously upload the same object, the latest upload request received by the system will replace the previous one. If you want to prevent an object from being accessed in parallel, you must use a lock mechanism in upper-layer applications.</p>
<div class="section" id="obs_03_0004__section31446668103644"><h4 class="sectiontitle">Concurrent Operation Examples</h4><p id="obs_03_0004__p1017669593957">1. When client 1 is uploading an object v1, client 2 is uploading an object v2 with the same name. After the successful uploads, both client 1 and client 2 can access the latest object data v2, as shown in <a href="#obs_03_0004__fig119911824133416">Figure 1</a>.</p>
<div class="fignone" id="obs_03_0004__fig119911824133416"><a name="obs_03_0004__fig119911824133416"></a><a name="fig119911824133416"></a><span class="figcap"><b>Figure 1 </b>Concurrent upload of the same object</span><br><span><img id="obs_03_0004__image10991132443415" src="en-us_image_0138437473.png"></span></div>
<p id="obs_03_0004__p50712446202027">2. When client 1 is uploading an object v1 and object metadata is not written yet, client 2 deletes an object with the same name. In this scenario, the upload operation of client 1 is still successful, and both client 1 and client 2 can access data object v1, as shown in <a href="#obs_03_0004__fig18399247153517">Figure 2</a>.</p>
<div class="fignone" id="obs_03_0004__fig18399247153517"><a name="obs_03_0004__fig18399247153517"></a><a name="fig18399247153517"></a><span class="figcap"><b>Figure 2 </b>Concurrent upload and deletion of the same object (1)</span><br><span><img id="obs_03_0004__image144001947123516" src="en-us_image_0138437574.png"></span></div>
<p id="obs_03_0004__p5166630420347">3. When client 1 has successfully uploaded an object v1 and object metadata is still being written, client 2 deletes an object with the same name. In this scenario, the upload operation of client 1 is still successful. However, when client 1 and client 2 attempt to download Object1, they may be able to access data object v1, or an error may be returned indicating that the object does not exist, as shown in <a href="#obs_03_0004__fig1972203713617">Figure 3</a>.</p>
<div class="fignone" id="obs_03_0004__fig1972203713617"><a name="obs_03_0004__fig1972203713617"></a><a name="fig1972203713617"></a><span class="figcap"><b>Figure 3 </b>Concurrent upload and deletion of the same object (2)</span><br><span><img id="obs_03_0004__image1297353783615" src="en-us_image_0138437668.png"></span></div>
<p id="obs_03_0004__p46450574202454">4. When client 1 is downloading an object, client 2 deletes an object with the same name. In this scenario, client 1 may have downloaded a full copy or only part of the object data. After a deletion success message is returned to client2, an attempt to download the object will fail, and an error will be returned indicating that the object does not exist, as shown in <a href="#obs_03_0004__fig7637151312371">Figure 4</a>.</p>
<div class="fignone" id="obs_03_0004__fig7637151312371"><a name="obs_03_0004__fig7637151312371"></a><a name="fig7637151312371"></a><span class="figcap"><b>Figure 4 </b>Concurrent download and deletion of the same object</span><br><span><img id="obs_03_0004__image1663881310374" src="en-us_image_0138437619.png"></span></div>
<p id="obs_03_0004__p7602593164835">5. When client 1 is downloading an object, client 2 is updating an object with the same name. In this scenario, client 1 may have downloaded a full copy or only part of the object data. After an update success message is returned to client 2, an attempt to download the object will succeed, and the latest data will be returned, as shown in <a href="#obs_03_0004__fig1934764718375">Figure 5</a>.</p>
<div class="fignone" id="obs_03_0004__fig1934764718375"><a name="obs_03_0004__fig1934764718375"></a><a name="fig1934764718375"></a><span class="figcap"><b>Figure 5 </b>Concurrent download and update of the same object</span><br><span><img id="obs_03_0004__image734894715373" src="en-us_image_0138437827.png"></span></div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0001.html">Overview</a></div>
</div>
</div>

41
docs/obs/api-swift/obs_03_0005.html Normal file
View File

@ -0,0 +1,41 @@
<a name="obs_03_0005"></a><a name="obs_03_0005"></a>
<h1 class="topictitle1">Suggestions on Container Performance Tuning</h1>
<div id="body1402566791344"><p id="obs_03_0005__p26929852175527">OBS (compatible with OpenStack Swift) updates the same metadata when processing concurrent PUT or DELETE operations on objects in a container. Performance of these operations is compromised due to metadata conflicts. For concurrent GET operations on objects in a container, however, performance is not compromised. For concurrent PUT or DELETE object operations on a container, OBS (compatible with OpenStack Swift) supports 15 Transactions Per Second (TPS). However, the performance of PUT an object is constrained by the TPS only when the object size is small. When the object size is relatively large, container performance has nothing to do with the TPS because PUT operations in this case mainly process object data and seldom update metadata. In general, container performance is inversely proportional to the object size in PUT operations. When tested, if the average size of concurrently uploaded objects exceeded 10 MB, the impact of concurrent metadata updates on operation performance could be ignored. For DELETE operations on objects, the performance of the container is constrained regardless of object sizes.</p>
<div class="note" id="obs_03_0005__note59576841175652"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0005__p66429527175652">The PUT, DELETE, and GET operations referred to here refer to those performed on different objects in a container. If concurrent operations are performed on the same object, container performance is determined by processing capabilities of one or several specific disks.</p>
</div></div>
<div class="section" id="obs_03_0005__section19704042175710"><h4 class="sectiontitle">Performance Tuning for Intensive PUT or DELETE Operations</h4><p id="obs_03_0005__p60900870175729">In typical application scenarios, such as archive and backup, there are a large number of concurrent PUT operations. To tune container performance, particularly in scenarios with small objects, the following methods are recommended:</p>
<ul id="obs_03_0005__ul141142551231"><li id="obs_03_0005__li711445518315">Balancing loads among multiple containers<p id="obs_03_0005__p4282034418034"><a name="obs_03_0005__li711445518315"></a><a name="li711445518315"></a>Upload backup data to different containers in OBS (compatible with OpenStack Swift) to eliminate data hotspots caused by concurrent PUT operations on the same container. As independent logical entities in OBS (compatible with OpenStack Swift), containers maintain their own metadata. Therefore, performance of one container is not affected by concurrent operations performed on other containers. In addition, data uploaded to different containers can be logically separated, which improves data listing and query performance.</p>
</li><li id="obs_03_0005__li611418551834">Controlling the number of concurrent operations on a container<p id="obs_03_0005__p5473053718120"><a name="obs_03_0005__li611418551834"></a><a name="li611418551834"></a>The performance of a container does not necessarily increase with the concurrent processing capability of that container. In contrast, when the concurrent processing capability of a container is excessively high, the performance of that container may deteriorate because OBS (compatible with OpenStack Swift) is busy handling conflicts in concurrent operations. In OBS (compatible with OpenStack Swift), the recommended concurrency value for a container is 15. This value has been tested for concurrently uploading small objects to the same container. If the object size is large, you can increase this value based on the container's TPS to achieve optimal container performance.</p>
</li><li id="obs_03_0005__li51141355438">Uploading small objects after packaging them<p id="obs_03_0005__p5928070618130"><a name="obs_03_0005__li51141355438"></a><a name="li51141355438"></a>In scenarios with a large number of small objects, to improve container performance and storage space utilization, first compress the small objects into packages like .tar or .zip files.</p>
</li><li id="obs_03_0005__li3114115515314">Using random object names<p id="obs_03_0005__p4381384818147"><a name="obs_03_0005__li3114115515314"></a><a name="li3114115515314"></a>You can use random object names to reduce the impact of concurrency conflicts on a single node. For example, in a typical scenario of log archiving, the names of objects to be uploaded may be as follows:</p>
<pre class="screen" id="obs_03_0005__screen6266904018446">yourcontainer/obslog/20140610-01.log.tar.gz
yourcontainer/obslog/20140610-02.log.tar.gz
yourcontainer/obslog/20140610-03.log.tar.gz
yourcontainer/obslog/20140610-04.log.tar.gz
...
yourcontainer/obslog/20140611-01.log.tar.gz
yourcontainer/obslog/20140611-02.log.tar.gz
yourcontainer/obslog/20140611-03.log.tar.gz
yourcontainer/obslog/20140611-04.log.tar.gz</pre>
<p id="obs_03_0005__p4595041318147">The names of these objects have the same prefix. When being uploaded concurrently, these objects are likely to be routed to the same node. To eliminate data hotspots and improve container performance, add random prefixes to object names. For example, a 6-digit hexadecimal string can be added to each of the object names:</p>
<pre class="screen" id="obs_03_0005__screen1256789318628">yourcontainer/6ac3e2-obslog/20140610-01.log.tar.gz
yourcontainer/b425da-obslog/20140610-02.log.tar.gz
yourcontainer/17fe36obslog/20140610-03.log.tar.gz
yourcontainer/ac96b4-obslog/20140610-04.log.tar.gz
...
yourcontainer/95d36e-obslog/20140611-01.log.tar.gz
yourcontainer/45c2d-obslog/20140611-02.log.tar.gz
yourcontainer/ea2cfe-obslog/20140611-03.log.tar.gz
yourcontainer/ba36c2-obslog/20140611-04.log.tar.gz</pre>
<div class="note" id="obs_03_0005__note5741629018210"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0005__p4698456918210">This method is only recommended when there are a lot of objects in a container.</p>
</div></div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0001.html">Overview</a></div>
</div>
</div>

20
docs/obs/api-swift/obs_03_0006.html Normal file
View File

@ -0,0 +1,20 @@
<a name="obs_03_0006"></a><a name="obs_03_0006"></a>
<h1 class="topictitle1">Methods of Calling APIs</h1>
<div id="body41429416"><p id="obs_03_0006__p37320431">This chapter explains how to use the REST APIs to access and operate OBS (compatible with OpenStack Swift), including how to locate a resource and send and authenticate a request. This chapter also covers the HTTP response codes returned by OBS (compatible with OpenStack Swift).</p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_03_0007.html">Locating a Resource</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0008.html">Request Methods</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0009.html">Naming Rules</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0010.html">Authenticating a Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0011.html">Responses</a></strong><br>
</li>
</ul>
</div>

88
docs/obs/api-swift/obs_03_0007.html Normal file
View File

@ -0,0 +1,88 @@
<a name="obs_03_0007"></a><a name="obs_03_0007"></a>
<h1 class="topictitle1">Locating a Resource</h1>
<div id="body8662426"><p id="obs_03_0007__p52452228">In REST, specific information or data on a network is represented by a resource, which is referenced with a uniform resource identifier (URI). Clients on a network can locate resources using uniform resource locators (URLs). In OBS (compatible with OpenStack Swift), a resource can be an account, container, object, or specific resource related to an account, container, or object. Such a resource is identified by a URL and can be operated after requests are sent using the URL.</p>
<p id="obs_03_0007__p60849796">The common URL format is as follows (the content in brackets ([ ]) is optional):</p>
<p id="obs_03_0007__p16350278">protocol ://hostname[:port] /v1/account[/container] [/object] [?param]</p>
<p id="obs_03_0007__p32077368"><a href="obs_03_0007.html#obs_03_0007__table6854763">Table 1</a> describes parameters in a URL.</p>
<div class="tablenoborder"><a name="obs_03_0007__table6854763"></a><a name="table6854763"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0007__table6854763" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URL parameters</caption><thead align="left"><tr id="obs_03_0007__row32038589"><th align="left" class="cellrowborder" valign="top" width="17.11%" id="mcps1.3.5.2.4.1.1"><p id="obs_03_0007__p44988935">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="65.60000000000001%" id="mcps1.3.5.2.4.1.2"><p id="obs_03_0007__p20225109">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.29%" id="mcps1.3.5.2.4.1.3"><p id="obs_03_0007__p65584754">Required or Optional</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0007__row27621136"><td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.5.2.4.1.1 "><p id="obs_03_0007__p54018267">protocol</p>
</td>
<td class="cellrowborder" valign="top" width="65.60000000000001%" headers="mcps1.3.5.2.4.1.2 "><p id="obs_03_0007__p26810586">The protocol used for sending requests. Possible values include HTTP and HTTPS.</p>
<p id="obs_03_0007__p39968683">You can specify HTTPS to ensure secure access to resources.</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.5.2.4.1.3 "><p id="obs_03_0007__p14183880">Required</p>
</td>
</tr>
<tr id="obs_03_0007__row53749059"><td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.5.2.4.1.1 "><p id="obs_03_0007__p63226018">hostname</p>
</td>
<td class="cellrowborder" valign="top" width="65.60000000000001%" headers="mcps1.3.5.2.4.1.2 "><p id="obs_03_0007__p5659133">The host name, namely, the domain name or service IP address of OBS (compatible with OpenStack Swift).</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.5.2.4.1.3 "><p id="obs_03_0007__p34112870">Required</p>
</td>
</tr>
<tr id="obs_03_0007__row48680776"><td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.5.2.4.1.1 "><p id="obs_03_0007__p44771124">port</p>
</td>
<td class="cellrowborder" valign="top" width="65.60000000000001%" headers="mcps1.3.5.2.4.1.2 "><p id="obs_03_0007__p49971353155110">The port enabled for protocols used for sending requests. The value varies with software server deployment. In OBS (compatible with OpenStack Swift), the HTTP port is <strong id="obs_03_0007__b403665502162048">80</strong> and the HTTPS port is <strong id="obs_03_0007__b1793576432162048">443</strong>. If this parameter is not specified, the default port will be used.</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.5.2.4.1.3 "><p id="obs_03_0007__p35946674">Optional</p>
</td>
</tr>
<tr id="obs_03_0007__row10729716172858"><td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.5.2.4.1.1 "><p id="obs_03_0007__p63800683172858">v1</p>
</td>
<td class="cellrowborder" valign="top" width="65.60000000000001%" headers="mcps1.3.5.2.4.1.2 "><p id="obs_03_0007__p472863172858">The version used in the request. <strong id="obs_03_0007__b46555465">v1</strong> indicates the object storage version.</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.5.2.4.1.3 "><p id="obs_03_0007__p25767589173144">Required</p>
</td>
</tr>
<tr id="obs_03_0007__row59923241172854"><td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.5.2.4.1.1 "><p id="obs_03_0007__p21944357172854">account</p>
</td>
<td class="cellrowborder" valign="top" width="65.60000000000001%" headers="mcps1.3.5.2.4.1.2 "><p id="obs_03_0007__p32662489172854">A user path. Each path identifies a unique user in the system. An account consists of a management prefix and a project ID, for example, <strong id="obs_03_0007__b842352706101410">AUTH_</strong><em id="obs_03_0007__i842352697101413">ProjectID</em>.</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.5.2.4.1.3 "><p id="obs_03_0007__p28415982172854">Required</p>
</td>
</tr>
<tr id="obs_03_0007__row10118767"><td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.5.2.4.1.1 "><p id="obs_03_0007__p42763981">container</p>
</td>
<td class="cellrowborder" valign="top" width="65.60000000000001%" headers="mcps1.3.5.2.4.1.2 "><p id="obs_03_0007__p52847049">A container path.</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.5.2.4.1.3 "><p id="obs_03_0007__p48772767">Optional</p>
</td>
</tr>
<tr id="obs_03_0007__row32859274"><td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.5.2.4.1.1 "><p id="obs_03_0007__p62499712">object</p>
</td>
<td class="cellrowborder" valign="top" width="65.60000000000001%" headers="mcps1.3.5.2.4.1.2 "><p id="obs_03_0007__p37952466">An object path.</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.5.2.4.1.3 "><p id="obs_03_0007__p59198213">Optional</p>
</td>
</tr>
<tr id="obs_03_0007__row55809335"><td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.5.2.4.1.1 "><p id="obs_03_0007__p54685102">param</p>
</td>
<td class="cellrowborder" valign="top" width="65.60000000000001%" headers="mcps1.3.5.2.4.1.2 "><p id="obs_03_0007__p47559554">The specific resource. By default, it is the requested container or object itself.</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.5.2.4.1.3 "><p id="obs_03_0007__p58187889">Optional</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="notice" id="obs_03_0007__note5961720811339"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="obs_03_0007__p6679283111339">For security reasons, HTTP is not recommended. HTTPS should be used instead.</p>
<p id="obs_03_0007__p47311530161543">In OBS (compatible with OpenStack Swift), HTTPS supports TLS 1.2 only.</p>
</div></div>
<div class="note" id="obs_03_0007__note17112947165810"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0007__p60908996165817">If the version in a URL is set to V1 (the correct one is actually v1), OBS (compatible with OpenStack Swift) returns a 404 Not Found error code, whereas OpenStack Swift returns a 400 Bad Request error code.</p>
</div></div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0006.html">Methods of Calling APIs</a></div>
</div>
</div>

59
docs/obs/api-swift/obs_03_0008.html Normal file
View File

@ -0,0 +1,59 @@
<a name="obs_03_0008"></a><a name="obs_03_0008"></a>
<h1 class="topictitle1">Request Methods</h1>
<div id="body3056034"><p id="obs_03_0008__p58889014">A request sent to OBS (compatible with OpenStack Swift) must comply with HTTP 1.1. In addition, the headers of a request must contain parameters defined in IAM, for example, the authentication fields.</p>
<p id="obs_03_0008__p28909296">HTTP supports several HTTP request methods, such as GET, PUT, POST, DELETE, HEAD, and COPY. A request method indicates how to access specific resources. <a href="obs_03_0008.html#obs_03_0008__table55931017">Table 1</a> describes the request methods supported by REST APIs that are provided by OBS (compatible with OpenStack Swift).</p>
<div class="tablenoborder"><a name="obs_03_0008__table55931017"></a><a name="table55931017"></a><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0008__table55931017" frame="border" border="1" rules="all"><caption><b>Table 1 </b>REST request methods supported by OBS (compatible with OpenStack Swift)</caption><thead align="left"><tr id="obs_03_0008__row43512002"><th align="left" class="cellrowborder" valign="top" width="23.79%" id="mcps1.3.3.2.3.1.1"><p id="obs_03_0008__p34811256">Method</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="76.21%" id="mcps1.3.3.2.3.1.2"><p id="obs_03_0008__p1139524">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0008__row25192587"><td class="cellrowborder" valign="top" width="23.79%" headers="mcps1.3.3.2.3.1.1 "><p id="obs_03_0008__p27333687">GET</p>
</td>
<td class="cellrowborder" valign="top" width="76.21%" headers="mcps1.3.3.2.3.1.2 "><p id="obs_03_0008__p66545072">Requests the server to return a specific resource, such as a container or object list or downloaded objects.</p>
</td>
</tr>
<tr id="obs_03_0008__row62034741"><td class="cellrowborder" valign="top" width="23.79%" headers="mcps1.3.3.2.3.1.1 "><p id="obs_03_0008__p58758091">PUT</p>
</td>
<td class="cellrowborder" valign="top" width="76.21%" headers="mcps1.3.3.2.3.1.2 "><p id="obs_03_0008__p61784930">Requests the server store a specific resource, such as a newly created container or uploaded objects.</p>
</td>
</tr>
<tr id="obs_03_0008__row19193461"><td class="cellrowborder" valign="top" width="23.79%" headers="mcps1.3.3.2.3.1.1 "><p id="obs_03_0008__p11166512">POST</p>
</td>
<td class="cellrowborder" valign="top" width="76.21%" headers="mcps1.3.3.2.3.1.2 "><p id="obs_03_0008__p32072255">Requests the server to modify a specific resource, such as a container or object metadata.</p>
</td>
</tr>
<tr id="obs_03_0008__row20214842"><td class="cellrowborder" valign="top" width="23.79%" headers="mcps1.3.3.2.3.1.1 "><p id="obs_03_0008__p26789475">DELETE</p>
</td>
<td class="cellrowborder" valign="top" width="76.21%" headers="mcps1.3.3.2.3.1.2 "><p id="obs_03_0008__p22463828">Requests the server to delete a specific resource, for example, an object.</p>
</td>
</tr>
<tr id="obs_03_0008__row64416501"><td class="cellrowborder" valign="top" width="23.79%" headers="mcps1.3.3.2.3.1.1 "><p id="obs_03_0008__p50354060">HEAD</p>
</td>
<td class="cellrowborder" valign="top" width="76.21%" headers="mcps1.3.3.2.3.1.2 "><p id="obs_03_0008__p52147080">Requests the server to return the digest of a specific resource, for example, the object metadata.</p>
</td>
</tr>
<tr id="obs_03_0008__row7477386152536"><td class="cellrowborder" valign="top" width="23.79%" headers="mcps1.3.3.2.3.1.1 "><p id="obs_03_0008__p187614152536">COPY</p>
</td>
<td class="cellrowborder" valign="top" width="76.21%" headers="mcps1.3.3.2.3.1.2 "><p id="obs_03_0008__p15196741152536">Requests the server to copy a specific resource, for example, an object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="obs_03_0008__section20832974"><h4 class="sectiontitle">Request Headers</h4><p id="obs_03_0008__p799618379388">When sending a REST request to OBS (compatible with OpenStack Swift), you need to add parameters in request headers. For details about request headers, see the descriptions of the specific operations.</p>
</div>
<div class="section" id="obs_03_0008__section354231515409"><h4 class="sectiontitle">HTTP Request Rules</h4><ul id="obs_03_0008__ul1849211915409"><li id="obs_03_0008__li3221135115409">There can be no more than 90 HTTP headers. If the token header is included, there can only be 91.</li><li id="obs_03_0008__li2146670415409">All HTTP headers cannot exceed 4,096 bytes.</li><li id="obs_03_0008__li5898261315409">An HTTP request line cannot exceed 8,192 bytes.</li><li id="obs_03_0008__li6108146915409">An HTTP request cannot exceed 5 GB.<div class="note" id="obs_03_0008__note4865197515409"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0008__p3521459415409">When sending a REST request to OBS (compatible with OpenStack Swift), you must comply with the preceding HTTP request rules. If any upper limit is exceeded, the error response may be different from that defined by OpenStack Swift. The request rules for the original OpenStack Swift APIs do not strictly check requests based on the preceding rules, but require users to comply with the preceding standard HTTP request rules.</p>
<p id="obs_03_0008__p29977592387">When the parameter length (request headers and content) of a request exceeds the buffer size of the server, OBS (compatible with OpenStack Swift) returns a 413 Request Entity Too Large: head, whereas OpenStack Swift returns a 400 Bad Request.</p>
</div></div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0006.html">Methods of Calling APIs</a></div>
</div>
</div>

29
docs/obs/api-swift/obs_03_0009.html Normal file
View File

@ -0,0 +1,29 @@
<a name="obs_03_0009"></a><a name="obs_03_0009"></a>
<h1 class="topictitle1">Naming Rules</h1>
<div id="body12905972"><p id="obs_03_0009__p35916793">If a request contains a container name or an object name, OBS (compatible with OpenStack Swift) starts to process the request only after checking that the name conforms to the specified naming rules.</p>
<div class="section" id="obs_03_0009__section41516642152937"><h4 class="sectiontitle">Account Naming Rules</h4><p id="obs_03_0009__p128623118530">Account names must be:</p>
<ul id="obs_03_0009__ul686417125316"><li id="obs_03_0009__li88642135317">Globally unique.</li><li id="obs_03_0009__li128645155313">Strings of 1 to 256 characters.</li></ul>
<div class="note" id="obs_03_0009__note46194888154127"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0009__p13100812154127">OBS (compatible with OpenStack Swift) uses the IDs of tenants created in the IAM system as account names.</p>
</div></div>
</div>
<div class="section" id="obs_03_0009__section54815683"><h4 class="sectiontitle">Container Naming Rules</h4><p id="obs_03_0009__p6679113613535">Container names must:</p>
<ul id="obs_03_0009__ul868383611531"><li id="obs_03_0009__li1868383625312">Be strings of 1 to 256 characters.</li><li id="obs_03_0009__li468303675314">Contain only case-sensitive letters, digits, periods (.), underscores (_), and hyphens (-).</li><li id="obs_03_0009__li868311369533">Use UTF-8 encoding.</li></ul>
<div class="note" id="obs_03_0009__note57785432154251"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0009__p50306844154251">To ensure system security, in a container name, the types of characters that are prohibited by OBS (compatible with OpenStack Swift) are more than those prohibited by OpenStack Swift.</p>
</div></div>
</div>
<div class="section" id="obs_03_0009__section23579102"><a name="obs_03_0009__section23579102"></a><a name="section23579102"></a><h4 class="sectiontitle">Object Naming Rules</h4><p id="obs_03_0009__p1712713531341">A key specifies the name of an object, and each object in a container must have a unique object key. Object names must:</p>
<ul id="obs_03_0009__ul1497457195416"><li id="obs_03_0009__li13477117195416">Be strings of 1 to 1024 characters, but they can start with any character.</li><li id="obs_03_0009__li17904729195416">Use UTF-8 encoding.</li><li id="obs_03_0009__li5298349819566">Not contain spaces, question marks (?), or double quotation marks (").</li></ul>
</div>
<div class="section" id="obs_03_0009__section29391483104815"><h4 class="sectiontitle">Rules About Custom Metadata</h4><p id="obs_03_0009__p81894114514">The following rules apply to custom metadata of accounts, containers, and objects:</p>
<ul id="obs_03_0009__ul9195311754"><li id="obs_03_0009__li419417110515">The value of a custom metadata item cannot exceed 256 bytes.</li><li id="obs_03_0009__li1019414112512">The name of a custom metadata item cannot exceed 128 bytes.</li><li id="obs_03_0009__li91941411059">All custom metadata items (including their names and values) cannot exceed 4,096 bytes.</li><li id="obs_03_0009__li101941712513">There can be no more than 90 custom metadata items.</li><li id="obs_03_0009__li161941211356">The name of a custom metadata item can contain only letters, digits, and ASCII characters.</li><li id="obs_03_0009__li91941512518">Custom metadata values can use UTF-8 encoding.</li><li id="obs_03_0009__li13195818516">Tab or space characters appearing after the name of a custom metadata item are deleted by default.</li></ul>
<div class="note" id="obs_03_0009__note20924719153955"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0009__p54104744153955">In OpenStack Swift, tab and space characters before and after the name of a custom metadata item are not deleted.</p>
</div></div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0006.html">Methods of Calling APIs</a></div>
</div>
</div>

11
docs/obs/api-swift/obs_03_0010.html Normal file
View File

@ -0,0 +1,11 @@
<a name="obs_03_0010"></a><a name="obs_03_0010"></a>
<h1 class="topictitle1">Authenticating a Request</h1>
<div id="body7837633"><p id="obs_03_0010__p34348834212753">Users of OBS (compatible with OpenStack Swift) must be authenticated using IAM. In a request sent by a client to OBS (compatible with OpenStack Swift), the request header must include the token ID obtained from the IAM service. This token ID is generated and encrypted by IAM based on the domain, project, and role information. In an OBS request, the <strong id="obs_03_0010__b53371190">X-Auth-Token</strong> is used to specify a token ID. For details about the usage, see the corresponding object operation method.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0006.html">Methods of Calling APIs</a></div>
</div>
</div>

318
docs/obs/api-swift/obs_03_0011.html Normal file
View File

File diff suppressed because it is too large Load Diff

14
docs/obs/api-swift/obs_03_0012.html Normal file
View File

@ -0,0 +1,14 @@
<a name="obs_03_0012"></a><a name="obs_03_0012"></a>
<h1 class="topictitle1">Error Responses</h1>
<div id="body8662426"><p id="obs_03_0012__p32631887">This chapter describes error responses returned by OBS (compatible with OpenStack Swift), including all error codes and error response syntax.</p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_03_0013.html">Error Code List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0014.html">Error Response Syntax</a></strong><br>
</li>
</ul>
</div>

135
docs/obs/api-swift/obs_03_0013.html Normal file
View File

File diff suppressed because it is too large Load Diff

17
docs/obs/api-swift/obs_03_0014.html Normal file
View File

@ -0,0 +1,17 @@
<a name="obs_03_0014"></a><a name="obs_03_0014"></a>
<h1 class="topictitle1">Error Response Syntax</h1>
<div id="body8662426"><div class="section" id="obs_03_0014__section49814798"><h4 class="sectiontitle">Error Response Headers</h4><p id="obs_03_0014__p59347407">When an error occurs, the header information contains:</p>
<p id="obs_03_0014__p6102738">Content-Type: application/*, which may be in HTML or text format</p>
<p id="obs_03_0014__p51025211">HTTP status code 3xx, 4xx, or 5xx. For details, see <a href="obs_03_0013.html#obs_03_0013__table30733758">Table 1</a>.</p>
</div>
<div class="section" id="obs_03_0014__section66197583"><h4 class="sectiontitle">Error Response Body</h4><p id="obs_03_0014__p29423671">The response body also contains information about the error. The following is an example of an error response body in an authentication failure.</p>
<pre class="screen" id="obs_03_0014__screen31457064">&lt;html&gt;&lt;h1&gt;Unauthorized&lt;/h1&gt;&lt;p&gt;This server could not verify that you are authorized to access the document you requested.&lt;/p&gt;&lt;/html&gt;</pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0012.html">Error Responses</a></div>
</div>
</div>

16
docs/obs/api-swift/obs_03_0015.html Normal file
View File

@ -0,0 +1,16 @@
<a name="obs_03_0015"></a><a name="obs_03_0015"></a>
<h1 class="topictitle1">Operations on Accounts</h1>
<div id="body8662426"><p id="obs_03_0015__p55162514">The requests that are sent by users to OBS (compatible with OpenStack Swift) must comply with REST specifications and contain required header parameters. If a request is successfully processed, OBS (compatible with OpenStack Swift) returns a success response. If the request cannot be processed, OBS (compatible with OpenStack Swift) returns a message that contains the cause of the error. This chapter describes REST operations for accounts with IAM authentication.</p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_03_0016.html">Show Account Details and List Containers</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0020.html">Create/Update/Delete Account Metadata</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0024.html">Show Account Metadata</a></strong><br>
</li>
</ul>
</div>

26
docs/obs/api-swift/obs_03_0016.html Normal file
View File

@ -0,0 +1,26 @@
<a name="obs_03_0016"></a><a name="obs_03_0016"></a>
<h1 class="topictitle1">Show Account Details and List Containers</h1>
<div id="body8662426"><p id="obs_03_0016__p37906687">This operation obtains account metadata and the list of containers in the account.</p>
<p id="obs_03_0016__p48974665103129">In the container list, container names are sorted in ascending order based on ASCII code.</p>
<div class="note" id="obs_03_0016__note1664537515290"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0016__p1559065215290">OBS (compatible with OpenStack Swift) employs a mechanism that automatically deletes accounts and their data in the background. There is no account deletion status corresponding to OpenStack Swift.</p>
<p id="obs_03_0016__p609814015290">The specific differences are as follows:</p>
<p id="obs_03_0016__p5488326615290">Account metadata does not include the X-Account-Status.</p>
<p id="obs_03_0016__p2418735015290">Showing account details does not involve the 410 Gone return code.</p>
</div></div>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_03_0017.html">Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0018.html">Response</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0019.html">Examples</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0015.html">Operations on Accounts</a></div>
</div>
</div>

152
docs/obs/api-swift/obs_03_0017.html Normal file
View File

File diff suppressed because it is too large Load Diff

175
docs/obs/api-swift/obs_03_0018.html Normal file
View File

File diff suppressed because it is too large Load Diff

46
docs/obs/api-swift/obs_03_0019.html Normal file
View File

@ -0,0 +1,46 @@
<a name="obs_03_0019"></a><a name="obs_03_0019"></a>
<h1 class="topictitle1">Examples</h1>
<div id="body8662426"><div class="section" id="obs_03_0019__section2201390"><h4 class="sectiontitle">Show Account Details and List Containers (Asking for a Plain Response)</h4><p id="obs_03_0019__p61892272161737">Show account details and list containers. Do not set a query parameter. Use the default plain response format.</p>
</div>
<pre class="codeblock" id="obs_03_0019__codeblock56481447153128">curl -i -H "X-auth-token:b8b574e33b0a4f74a1961bed1b4784b8" "http://172.28.5.30:80/v1/AUTH_0ce042a9be6140769b12c1001d41bcf9" -X GET</pre>
<pre class="screen" id="obs_03_0019__screen4496161">HTTP/1.1 200 OK
X-Trans-Id: tx19cbb9377b2eb8a164ac8-c40e979e9b
Accept-Ranges: bytes
Content-Type: text/plain;charset=UTF-8
Date: Wed, 16 Sep 2015 07:10:18 GMT
X-Account-Bytes-Used: 0
X-Account-Container-Count: 3
X-Account-Object-Count: 0
X-Account-Project-Domain-Id: default
X-Timestamp: 1442371465.946
Content-Length: 23
<em id="obs_03_0019__i3993113416413">[23 Byte data content]</em></pre>
<div class="section" id="obs_03_0019__section60098234144536"><h4 class="sectiontitle">Show Account Details and List Containers (Asking for an XML Response)</h4><p id="obs_03_0019__p48068385162043">Show account details and list containers. Use the <strong id="obs_03_0019__b19750463">prefix=abc</strong> query parameter, and set the response format to <strong id="obs_03_0019__b43536440">xml</strong>.</p>
<pre class="codeblock" id="obs_03_0019__codeblock56618550154229">curl -i -H "X-auth-token:b8b574e33b0a4f74a1961bed1b4784b8" "http://172.28.5.30:80/v1/AUTH_0ce042a9be6140769b12c1001d41bcf9?format=xml&amp;prefix=abc" -X GET</pre>
</div>
<pre class="screen" id="obs_03_0019__screen46317933145020">HTTP/1.1 200 OK
X-Trans-Id: tx200c074b35f50910061e7-067ab2f1d4
Accept-Ranges: bytes
Content-Type: application/xml;charset=UTF-8
Date: Wed, 16 Sep 2015 07:12:09 GMT
X-Account-Bytes-Used: 0
X-Account-Container-Count: 3
X-Account-Object-Count: 0
X-Account-Project-Domain-Id: default
X-timestamp: 1442371465.946
Content-Length: 256
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;account name="AUTH_0ce042a9be6140769b12c1001d41bcf9"&gt;
&lt;container&gt;&lt;name&gt;abcc122&lt;/name&gt;&lt;count&gt;0&lt;/count&gt;&lt;bytes&gt;0&lt;/bytes&gt;&lt;/container&gt;
&lt;container&gt;&lt;name&gt;abcd123&lt;/name&gt;&lt;count&gt;0&lt;/count&gt;&lt;bytes&gt;0&lt;/bytes&gt;&lt;/container&gt;
&lt;/account&gt;</pre>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0016.html">Show Account Details and List Containers</a></div>
</div>
</div>

21
docs/obs/api-swift/obs_03_0020.html Normal file
View File

@ -0,0 +1,21 @@
<a name="obs_03_0020"></a><a name="obs_03_0020"></a>
<h1 class="topictitle1">Create/Update/Delete Account Metadata</h1>
<div id="body8662426"><p id="obs_03_0020__p24533531">Users can send requests to create, update, or delete account metadata.</p>
<p id="obs_03_0020__p62975918105157">For details about metadata rules, see <a href="obs_03_0009.html">Naming Rules</a>.</p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_03_0021.html">Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0022.html">Response</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0023.html">Examples</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0015.html">Operations on Accounts</a></div>
</div>
</div>

151
docs/obs/api-swift/obs_03_0021.html Normal file
View File

File diff suppressed because it is too large Load Diff

57
docs/obs/api-swift/obs_03_0022.html Normal file
View File

@ -0,0 +1,57 @@
<a name="obs_03_0022"></a><a name="obs_03_0022"></a>
<h1 class="topictitle1">Response</h1>
<div id="body8662426"><div class="section" id="obs_03_0022__section46595788165128"><h4 class="sectiontitle">Response Headers</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0022__table38077202192918" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_03_0022__row47910623192918"><th align="left" class="cellrowborder" valign="top" width="20.419999999999998%" id="mcps1.3.1.2.1.4.1.1"><p id="obs_03_0022__p55555255192918">Header</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.55%" id="mcps1.3.1.2.1.4.1.2"><p id="obs_03_0022__p3681820192918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60.029999999999994%" id="mcps1.3.1.2.1.4.1.3"><p id="obs_03_0022__p29791989192918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0022__row64340907192918"><td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.1.2.1.4.1.1 "><p id="obs_03_0022__p44230949192918">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="19.55%" headers="mcps1.3.1.2.1.4.1.2 "><p id="obs_03_0022__p25937099192918">String</p>
<p id="obs_03_0022__p32107307192918">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="60.029999999999994%" headers="mcps1.3.1.2.1.4.1.3 "><p id="obs_03_0022__p50555071192918">If the operation succeeds, this value is 0.</p>
<p id="obs_03_0022__p52342462192918">If the operation fails, this value is the length of the error text in the response body.</p>
</td>
</tr>
<tr id="obs_03_0022__row64886044192918"><td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.1.2.1.4.1.1 "><p id="obs_03_0022__p21278236192918">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="19.55%" headers="mcps1.3.1.2.1.4.1.2 "><p id="obs_03_0022__p45815573192918">String</p>
<p id="obs_03_0022__p9686974192918">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="60.029999999999994%" headers="mcps1.3.1.2.1.4.1.3 "><p id="obs_03_0022__p46447390192918">MIME type of the text in the response body.</p>
</td>
</tr>
<tr id="obs_03_0022__row15373327192918"><td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.1.2.1.4.1.1 "><p id="obs_03_0022__p37279969192918">Date</p>
</td>
<td class="cellrowborder" valign="top" width="19.55%" headers="mcps1.3.1.2.1.4.1.2 "><p id="obs_03_0022__p66887499192918">Datetime</p>
<p id="obs_03_0022__p65116585192918">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="60.029999999999994%" headers="mcps1.3.1.2.1.4.1.3 "><p id="obs_03_0022__p39952043192918">Transaction date and time.</p>
</td>
</tr>
<tr id="obs_03_0022__row24024074192918"><td class="cellrowborder" valign="top" width="20.419999999999998%" headers="mcps1.3.1.2.1.4.1.1 "><p id="obs_03_0022__p66901805192918">X-Trans-Id</p>
</td>
<td class="cellrowborder" valign="top" width="19.55%" headers="mcps1.3.1.2.1.4.1.2 "><p id="obs_03_0022__p50337162192918">Uuid</p>
<p id="obs_03_0022__p50381277192918">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="60.029999999999994%" headers="mcps1.3.1.2.1.4.1.3 "><p id="obs_03_0022__p54351617192918">A unique transaction identifier.</p>
<p id="obs_03_0022__p19402508192918"></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0020.html">Create/Update/Delete Account Metadata</a></div>
</div>
</div>

34
docs/obs/api-swift/obs_03_0023.html Normal file
View File

@ -0,0 +1,34 @@
<a name="obs_03_0023"></a><a name="obs_03_0023"></a>
<h1 class="topictitle1">Examples</h1>
<div id="body8662426"><div class="section" id="obs_03_0023__section31331064"><h4 class="sectiontitle">Create Account Metadata</h4><p id="obs_03_0023__p22463557181153">Create Book and Subject metadata:</p>
</div>
<pre class="codeblock" id="obs_03_0023__codeblock65074267153827">curl -i -H "X-auth-token:b8b574e33b0a4f74a1961bed1b4784b8" "http://172.28.5.31:80/v1/AUTH_0ce042a9be6140769b12c1001d41bcf9" -X POST -H "X-Account-Meta-Book:MobyDick" -H "X-Account-Meta-Subject:Literature"</pre>
<pre class="screen" id="obs_03_0023__screen8634633">HTTP/1.1 204 No Content
X-Trans-Id: tx000001513971bc1a370c0-93967ab85f
Content-Length: 0
Content-Type: text/html;charset=UTF-8
Date: Tue, 24 Nov 2015 12:22:13 GMT</pre>
<div class="section" id="obs_03_0023__section3117276019246"><h4 class="sectiontitle">Update Account Metadata</h4><p id="obs_03_0023__p4196562819246">Update the Subject metadata:</p>
</div>
<pre class="codeblock" id="obs_03_0023__codeblock5721306015398">curl -i -H "X-auth-token:b8b574e33b0a4f74a1961bed1b4784b8" "http://172.28.5.31:80/v1/AUTH_0ce042a9be6140769b12c1001d41bcf9" -X POST -H "X-Account-Meta-Subject:ChineseLiterature"</pre>
<pre class="screen" id="obs_03_0023__screen176006520249">HTTP/1.1 204 No Content
X-Trans-Id: tx0000015139725538370c0-f6e0c56435
Content-Length: 0
Content-Type: text/html;charset=UTF-8
Date: Tue, 24 Nov 2015 12:22:53 GMT</pre>
<div class="section" id="obs_03_0023__section21941182181512"><h4 class="sectiontitle">Delete Account Metadata</h4><p id="obs_03_0023__p32405324181512">Delete the Subject metadata:</p>
</div>
<pre class="codeblock" id="obs_03_0023__codeblock28121701153943">curl -i -H "X-auth-token:b8b574e33b0a4f74a1961bed1b4784b8" "http://172.28.5.31:80/v1/AUTH_0ce042a9be6140769b12c1001d41bcf9" -X POST -H "X-Remove-Account-Meta-Subject:d"</pre>
<pre class="screen" id="obs_03_0023__screen10456083181512">HTTP/1.1 204 No Content
X-Trans-Id: tx000001513972ce7c370c0-40b77d13e2
Content-Length: 0
Content-Type: text/html;charset=UTF-8
Date: Tue, 24 Nov 2015 12:23:24 GMT</pre>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0020.html">Create/Update/Delete Account Metadata</a></div>
</div>
</div>

20
docs/obs/api-swift/obs_03_0024.html Normal file
View File

@ -0,0 +1,20 @@
<a name="obs_03_0024"></a><a name="obs_03_0024"></a>
<h1 class="topictitle1">Show Account Metadata</h1>
<div id="body8662426"><p id="obs_03_0024__p22915722">Users can send requests to obtain account metadata. This operation is similar to a function described in <a href="obs_03_0016.html">Show Account Details and List Containers</a>. Only account details are shown. Containers are not listed.</p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_03_0025.html">Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0026.html">Response</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0027.html">Examples</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0015.html">Operations on Accounts</a></div>
</div>
</div>

79
docs/obs/api-swift/obs_03_0025.html Normal file
View File

@ -0,0 +1,79 @@
<a name="obs_03_0025"></a><a name="obs_03_0025"></a>
<h1 class="topictitle1">Request</h1>
<div id="body8662426"><div class="section" id="obs_03_0025__section3855846091844"><h4 class="sectiontitle">Method</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0025__table3622757091844" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Method description</caption><thead align="left"><tr id="obs_03_0025__row5885523391844"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.1.2.2.4.1.1"><p id="obs_03_0025__p254458491844">Method</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.1.2.2.4.1.2"><p id="obs_03_0025__p4306302491844"><strong id="obs_03_0025__b5202290091844">URI</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.1.2.2.4.1.3"><p id="obs_03_0025__p5310538591844">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0025__row5912023091844"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.1.2.2.4.1.1 "><p id="obs_03_0025__p2400930591844">HEAD</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.1.2.2.4.1.2 "><p id="obs_03_0025__p6570552491844">/v1/{account}</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.1.2.2.4.1.3 "><p id="obs_03_0025__p2054723291844">Shows metadata of a specified account.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="obs_03_0025__p5070736491844"><strong id="obs_03_0025__b47012596">{account}</strong> indicates the name of an account. Metadata of an account includes the number of containers, number of objects, and total number of bytes that are stored in OBS for the account.</p>
<p id="obs_03_0025__p5371309291844">This operation does not involve a request body.</p>
</div>
<div class="section" id="obs_03_0025__section1365578791844"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="obs_03_0025__screen143781110409">curl -i $publicURL -X HEAD -H "X-Auth-Token:$token"</pre>
</div>
<div class="section" id="obs_03_0025__section529000091844"><h4 class="sectiontitle">Request Query Parameters</h4><p id="obs_03_0025__p2583686191844">This operation does not include request query parameters.</p>
</div>
<div class="section" id="obs_03_0025__section187973291844"><h4 class="sectiontitle">Request Headers</h4><p id="obs_03_0025__p20492254154423">Request URI parameters</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0025__table50212566154423" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_03_0025__row49025617154423"><th align="left" class="cellrowborder" valign="top" width="20.66%" id="mcps1.3.4.3.1.4.1.1"><p id="obs_03_0025__p11652032154423">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.399999999999999%" id="mcps1.3.4.3.1.4.1.2"><p id="obs_03_0025__p38615046154423">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.94%" id="mcps1.3.4.3.1.4.1.3"><p id="obs_03_0025__p31754770154423">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0025__row63778126154423"><td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.4.3.1.4.1.1 "><p id="obs_03_0025__p65754607154423">{account}</p>
</td>
<td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.3.4.3.1.4.1.2 "><p id="obs_03_0025__p24522989154423">String</p>
<p id="obs_03_0025__p19380314154423">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.4.3.1.4.1.3 "><p id="obs_03_0025__p26301614154423">A unique account name. In the current version, it indicates a unique ID for the account.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="obs_03_0025__p25082980154423">Request header parameters</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0025__table24420230154423" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_03_0025__row63928991154423"><th align="left" class="cellrowborder" valign="top" width="20.66%" id="mcps1.3.4.5.1.4.1.1"><p id="obs_03_0025__p10865822154423">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.399999999999999%" id="mcps1.3.4.5.1.4.1.2"><p id="obs_03_0025__p2338936154423">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.94%" id="mcps1.3.4.5.1.4.1.3"><p id="obs_03_0025__p27363246154423">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0025__row16474171154423"><td class="cellrowborder" valign="top" width="20.66%" headers="mcps1.3.4.5.1.4.1.1 "><p id="obs_03_0025__p59339488154423">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="14.399999999999999%" headers="mcps1.3.4.5.1.4.1.2 "><p id="obs_03_0025__p41769209154423">String</p>
<p id="obs_03_0025__p40378565154423">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="64.94%" headers="mcps1.3.4.5.1.4.1.3 "><p id="obs_03_0025__p49438312154423">Authentication token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0024.html">Show Account Metadata</a></div>
</div>
</div>

138
docs/obs/api-swift/obs_03_0026.html Normal file
View File

File diff suppressed because it is too large Load Diff

25
docs/obs/api-swift/obs_03_0027.html Normal file
View File

@ -0,0 +1,25 @@
<a name="obs_03_0027"></a><a name="obs_03_0027"></a>
<h1 class="topictitle1">Examples</h1>
<div id="body8662426"><div class="section" id="obs_03_0027__section42277158"><h4 class="sectiontitle">Show Account Metadata</h4><p id="obs_03_0027__p27421352154858">Show account metadata.</p>
</div>
<pre class="codeblock" id="obs_03_0027__codeblock7208083154835">curl -i -H "X-Auth-token:9d6c288edff8434ea23108e6516ae5a5" "http://172.28.5.30:80/v1/AUTH_0ce042a9be6140769b12c1001d41bcf9" -X HEAD</pre>
<pre class="screen" id="obs_03_0027__screen15155525">HTTP/1.1 204 No Content
X-Trans-Id: tx000001513970d65e370c0-0480bf0ace
Accept-Ranges: bytes
Content-Length: 0
Content-Type: text/plain;charset=UTF-8
Date: Tue, 24 Nov 2015 12:21:14 GMT
X-Account-Bytes-Used: 0
X-Account-Container-Count: 0
X-Account-Meta-Book: firstbook
X-Account-Object-Count: 0
X-Account-Project-Domain-Id: default
X-Timestamp: 1448367617.422</pre>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0024.html">Show Account Metadata</a></div>
</div>
</div>

22
docs/obs/api-swift/obs_03_0028.html Normal file
View File

@ -0,0 +1,22 @@
<a name="obs_03_0028"></a><a name="obs_03_0028"></a>
<h1 class="topictitle1">Operations on Containers</h1>
<div id="body1442322212588"><p id="obs_03_0028__p55162514">The requests that are sent by users to OBS must comply with REST specifications and contain required header parameters. If a request is successfully processed, OBS (compatible with OpenStack Swift) returns a success response. If the request cannot be processed, OBS (compatible with OpenStack Swift) returns a message that contains the cause of the error. This chapter describes REST operations on containers. Authentication is implemented based on IAM.</p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_03_0029.html">Show Container Details and List Objects</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0033.html">Create Container</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0037.html">Delete Container</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0041.html">Create/Update/Delete Container Metadata</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0045.html">Show Container Metadata</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0049.html">Batch Delete Containers</a></strong><br>
</li>
</ul>
</div>

21
docs/obs/api-swift/obs_03_0029.html Normal file
View File

@ -0,0 +1,21 @@
<a name="obs_03_0029"></a><a name="obs_03_0029"></a>
<h1 class="topictitle1">Show Container Details and List Objects</h1>
<div id="body1442461140547"><p id="obs_03_0029__p37906687">This operation obtains container metadata and the list of objects in the container.</p>
<p id="obs_03_0029__p48974665103129">In an object list, objects are sorted by name in ascending order based on the comparison of binary memcmp() functions.</p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_03_0030.html">Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0031.html">Response</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0032.html">Examples</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0028.html">Operations on Containers</a></div>
</div>
</div>

196
docs/obs/api-swift/obs_03_0030.html Normal file
View File

File diff suppressed because it is too large Load Diff

146
docs/obs/api-swift/obs_03_0031.html Normal file
View File

File diff suppressed because it is too large Load Diff

54
docs/obs/api-swift/obs_03_0032.html Normal file
View File

@ -0,0 +1,54 @@
<a name="obs_03_0032"></a><a name="obs_03_0032"></a>
<h1 class="topictitle1">Examples</h1>
<div id="body1442461140553"><div class="section" id="obs_03_0032__section2201390"><h4 class="sectiontitle">Show Container Details: Plain Format</h4><p id="obs_03_0032__p61892272161737">Show metadata of the <strong id="obs_03_0032__b54333736">testcontainer</strong> container and list objects. Do not set a query parameter. Use the default plain response format.</p>
</div>
<pre class="codeblock" id="obs_03_0032__codeblock4901598217258">curl -i http://172.28.54.10:80/v1/AUTH_4b34aa268d8c45879cf4da16443d3f95/testcontainer -H "x-auth-token:c1f21a34cce442efbd4957018263cc2c" -X GET</pre>
<pre class="screen" id="obs_03_0032__screen20404063172540">HTTP/1.1 200 OK
X-Trans-Id: tx0000015133a73737370a1-35e31d5be7
Accept-Ranges: bytes
Content-Length: 10
Content-Type: text/plain;charset=UTF-8
Date: Mon, 23 Nov 2015 09:22:58 GMT
X-Container-Bytes-Used: 5027
X-Container-Object-Count: 2
X-Timestamp: 1448270495.79460
<em id="obs_03_0032__i18991185264210">[10 Byte data content]</em></pre>
<div class="section" id="obs_03_0032__section60098234144536"><h4 class="sectiontitle">Show Container Details: JSON Format</h4><p id="obs_03_0032__p48068385162043">Show metadata of the <strong id="obs_03_0032__b15994879">testcontainer</strong> container and list objects. Specify the JSON response format.</p>
<pre class="codeblock" id="obs_03_0032__codeblock31392800173543">curl -i http://172.28.54.10:80/v1/AUTH_4b34aa268d8c45879cf4da16443d3f95/testcontainer?format=json -H "x-auth-token:c1f21a34cce442efbd4957018263cc2c" -X GET</pre>
</div>
<p id="obs_03_0032__p5003912162424">A JSON response is returned. The response body contains object information such as <strong id="obs_03_0032__b50433639">hash</strong>, <strong id="obs_03_0032__b51249570">bytes</strong>, and <strong id="obs_03_0032__b58592948">content_type</strong>.</p>
<pre class="screen" id="obs_03_0032__screen49399902173354">HTTP/1.1 200 OK
X-Trans-Id: tx0000015133aa2422370a1-13b8629ff1
Accept-Ranges: bytes
Content-Length: 335
Content-Type: application/json;charset=UTF-8
Date: Mon, 23 Nov 2015 09:26:09 GMT
X-Container-Bytes-Used: 5027
X-Container-Object-Count: 2
X-Timestamp: 1448270495.79460
[
{
"hash": "0481164fe6931fb86ca4d8e8b3689efb",
"bytes": 4337,
"content_type": "application/octet-stream",
"last_modified": "2015-11-23T09:22:22.859650",
"name": "jack"
},
{
"hash": "1e5d213baf0069e26805f5d4efc900fe",
"bytes": 690,
"content_type": "application/octet-stream",
"last_modified": "2015-11-23T09:22:44.748920",
"name": "rose"
}
]</pre>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0029.html">Show Container Details and List Objects</a></div>
</div>
</div>

20
docs/obs/api-swift/obs_03_0033.html Normal file
View File

@ -0,0 +1,20 @@
<a name="obs_03_0033"></a><a name="obs_03_0033"></a>
<h1 class="topictitle1">Create Container</h1>
<div id="body1442461140554"><p id="obs_03_0033__p37906687">This operation creates a container under a specified account. Every container within a given account must have a unique name, but containers can have the same name as long as they are under different accounts.</p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_03_0034.html">Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0035.html">Response</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0036.html">Examples</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0028.html">Operations on Containers</a></div>
</div>
</div>

128
docs/obs/api-swift/obs_03_0034.html Normal file
View File

File diff suppressed because it is too large Load Diff

60
docs/obs/api-swift/obs_03_0035.html Normal file
View File

@ -0,0 +1,60 @@
<a name="obs_03_0035"></a><a name="obs_03_0035"></a>
<h1 class="topictitle1">Response</h1>
<div id="body1442461140560"><div class="section" id="obs_03_0035__section30570743"><h4 class="sectiontitle">Response Headers</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0035__table60070351195511" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_03_0035__row26800198195511"><th align="left" class="cellrowborder" valign="top" width="23.62%" id="mcps1.3.1.2.1.4.1.1"><p id="obs_03_0035__p23332461195511">Header</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.61%" id="mcps1.3.1.2.1.4.1.2"><p id="obs_03_0035__p10881151195511">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.769999999999996%" id="mcps1.3.1.2.1.4.1.3"><p id="obs_03_0035__p8958054195511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0035__row54513802195511"><td class="cellrowborder" valign="top" width="23.62%" headers="mcps1.3.1.2.1.4.1.1 "><p id="obs_03_0035__p53541842195511">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="21.61%" headers="mcps1.3.1.2.1.4.1.2 "><p id="obs_03_0035__p41921959195511">String</p>
<p id="obs_03_0035__p41753313195511">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="54.769999999999996%" headers="mcps1.3.1.2.1.4.1.3 "><p id="obs_03_0035__p37850390195511">Length of a response body.</p>
</td>
</tr>
<tr id="obs_03_0035__row8515749195511"><td class="cellrowborder" valign="top" width="23.62%" headers="mcps1.3.1.2.1.4.1.1 "><p id="obs_03_0035__p18687043195511">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="21.61%" headers="mcps1.3.1.2.1.4.1.2 "><p id="obs_03_0035__p37255481195511">String</p>
<p id="obs_03_0035__p66863877195511">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="54.769999999999996%" headers="mcps1.3.1.2.1.4.1.3 "><p id="obs_03_0035__p47264947195511">MIME type of the object.</p>
</td>
</tr>
<tr id="obs_03_0035__row22731343195511"><td class="cellrowborder" valign="top" width="23.62%" headers="mcps1.3.1.2.1.4.1.1 "><p id="obs_03_0035__p29299519195511">Date</p>
</td>
<td class="cellrowborder" valign="top" width="21.61%" headers="mcps1.3.1.2.1.4.1.2 "><p id="obs_03_0035__p24450856195511">Datetime</p>
<p id="obs_03_0035__p18731113195511">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="54.769999999999996%" headers="mcps1.3.1.2.1.4.1.3 "><p id="obs_03_0035__p40825145195511">Transaction date and time.</p>
</td>
</tr>
<tr id="obs_03_0035__row31881986195511"><td class="cellrowborder" valign="top" width="23.62%" headers="mcps1.3.1.2.1.4.1.1 "><p id="obs_03_0035__p32304068195511">X-Trans-Id</p>
</td>
<td class="cellrowborder" valign="top" width="21.61%" headers="mcps1.3.1.2.1.4.1.2 "><p id="obs_03_0035__p66492702195511">Uuid</p>
<p id="obs_03_0035__p61563412195511">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="54.769999999999996%" headers="mcps1.3.1.2.1.4.1.3 "><p id="obs_03_0035__p20580486195511">A unique transaction identifier.</p>
<p id="obs_03_0035__p51006653195511"></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="obs_03_0035__section29255058162616"><h4 class="sectiontitle">Response Body Parameters</h4><p id="obs_03_0035__p38537106162939">The request does not include response body parameters.</p>
</div>
<div class="section" id="obs_03_0035__section6388915"><h4 class="sectiontitle">Error Responses</h4><p id="obs_03_0035__p39580130143015">All the error responses are contained in <a href="obs_03_0013.html#obs_03_0013__table30733758">Table 1</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0033.html">Create Container</a></div>
</div>
</div>

35
docs/obs/api-swift/obs_03_0036.html Normal file
View File

@ -0,0 +1,35 @@
<a name="obs_03_0036"></a><a name="obs_03_0036"></a>
<h1 class="topictitle1">Examples</h1>
<div id="body1442461140561"><div class="section" id="obs_03_0036__section2201390"><h4 class="sectiontitle">Create Container</h4><p id="obs_03_0036__p61892272161737">Create a container named <strong id="obs_03_0036__b27369819">marktwain</strong>:</p>
</div>
<pre class="codeblock" id="obs_03_0036__codeblock44595006102738">curl -i -H "X-Auth-token:caf12eeaae6b45b1afcb7ad1d6588a4f" "http://172.28.5.30:80/v1/AUTH_0ce042a9be6140769b12c1001d41bcf9/marktwain" -X PUT</pre>
<pre class="screen" id="obs_03_0036__screen4496161">HTTP/1.1 201 Created
X-Trans-Id: tx568a5d33add18d5f73757-b6dc185e91
Content-Type: text/html;charset=UTF-8
Date: Fri, 18 Sep 2015 01:58:51 GMT
Content-Length: 0</pre>
<div class="section" id="obs_03_0036__section60098234144536"><h4 class="sectiontitle">Create Existing Container</h4><p id="obs_03_0036__p48068385162043">Container <strong id="obs_03_0036__b42932445">marktwain</strong> exists. Create it again.</p>
<pre class="codeblock" id="obs_03_0036__codeblock6275172102819">curl -i -H "X-Auth-token:caf12eeaae6b45b1afcb7ad1d6588a4f" "http://172.28.5.30:80/v1/AUTH_0ce042a9be6140769b12c1001d41bcf9/marktwain" -X PUT</pre>
</div>
<pre class="screen" id="obs_03_0036__screen46317933145020">HTTP/1.1 202 Accepted
X-Trans-Id: txed4fe8ffb3219cd0db230-cbe125775d
Content-Type: text/html;charset=UTF-8
Date: Fri, 18 Sep 2015 01:59:01 GMT
Content-Length: 76
&lt;html&gt;&lt;h1&gt;Accepted&lt;/h1&gt;&lt;p&gt;The request is accepted for processing.&lt;/p&gt;&lt;/html&gt;</pre>
<div class="section" id="obs_03_0036__section55269209103042"><h4 class="sectiontitle">Create Container (with a Read ACL Specified)</h4><p id="obs_03_0036__p47919921103128">Create a container and specify the <strong id="obs_03_0036__b34248408">X-Container-Read</strong> metadata.</p>
<pre class="codeblock" id="obs_03_0036__codeblock18835946173715">curl -i http://172.28.54.10:80/v1/AUTH_4b34aa268d8c45879cf4da16443d3f95/ruanman -H"x-auth-token:c1f21a34cce442efbd4957018263cc2c" -H"x-container-read:.r:*" -X PUT</pre>
<pre class="screen" id="obs_03_0036__screen28157710103234">HTTP/1.1 201 Created
X-Trans-Id: tx000001513752eba4370a5-4f8cd5e885
Content-Length: 0
Content-Type: text/html;charset=UTF-8
Date: Tue, 24 Nov 2015 02:29:24 GMT</pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0033.html">Create Container</a></div>
</div>
</div>

21
docs/obs/api-swift/obs_03_0037.html Normal file
View File

@ -0,0 +1,21 @@
<a name="obs_03_0037"></a><a name="obs_03_0037"></a>
<h1 class="topictitle1">Delete Container</h1>
<div id="body1442461140561"><p id="obs_03_0037__p37906687">This operation deletes a container from a specified account.</p>
<p id="obs_03_0037__p6499118610142">Only empty containers can be deleted.</p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_03_0038.html">Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0039.html">Response</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0040.html">Examples</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0028.html">Operations on Containers</a></div>
</div>
</div>

109
docs/obs/api-swift/obs_03_0038.html Normal file
View File

File diff suppressed because it is too large Load Diff

57
docs/obs/api-swift/obs_03_0039.html Normal file
View File

@ -0,0 +1,57 @@
<a name="obs_03_0039"></a><a name="obs_03_0039"></a>
<h1 class="topictitle1">Response</h1>
<div id="body1442461140567"><div class="section" id="obs_03_0039__section30570743"><h4 class="sectiontitle">Response Headers</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_03_0039__table3295090919581" frame="border" border="1" rules="all"><thead align="left"><tr id="obs_03_0039__row1039828619581"><th align="left" class="cellrowborder" valign="top" width="24.177582241775823%" id="mcps1.3.1.2.1.4.1.1"><p id="obs_03_0039__p3695482319581">Header</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.858214178582145%" id="mcps1.3.1.2.1.4.1.2"><p id="obs_03_0039__p4055068519581">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.96420357964204%" id="mcps1.3.1.2.1.4.1.3"><p id="obs_03_0039__p6338002319581">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="obs_03_0039__row3350822119581"><td class="cellrowborder" valign="top" width="24.177582241775823%" headers="mcps1.3.1.2.1.4.1.1 "><p id="obs_03_0039__p2981141719581">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="17.858214178582145%" headers="mcps1.3.1.2.1.4.1.2 "><p id="obs_03_0039__p6591454419581">String</p>
<p id="obs_03_0039__p5635999019581">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="57.96420357964204%" headers="mcps1.3.1.2.1.4.1.3 "><p id="obs_03_0039__p175650019581">If the operation succeeds, this value is 0.</p>
<p id="obs_03_0039__p1580850119581">If the operation fails, this value is the length of the error text in the response body.</p>
</td>
</tr>
<tr id="obs_03_0039__row805878619581"><td class="cellrowborder" valign="top" width="24.177582241775823%" headers="mcps1.3.1.2.1.4.1.1 "><p id="obs_03_0039__p4878189619581">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="17.858214178582145%" headers="mcps1.3.1.2.1.4.1.2 "><p id="obs_03_0039__p5901950319581">String</p>
<p id="obs_03_0039__p6141348219581">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="57.96420357964204%" headers="mcps1.3.1.2.1.4.1.3 "><p id="obs_03_0039__p843614919581">MIME type of the object.</p>
</td>
</tr>
<tr id="obs_03_0039__row881647819581"><td class="cellrowborder" valign="top" width="24.177582241775823%" headers="mcps1.3.1.2.1.4.1.1 "><p id="obs_03_0039__p4304613519581">Date</p>
</td>
<td class="cellrowborder" valign="top" width="17.858214178582145%" headers="mcps1.3.1.2.1.4.1.2 "><p id="obs_03_0039__p6418488019581">Datetime</p>
<p id="obs_03_0039__p4079300819581">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="57.96420357964204%" headers="mcps1.3.1.2.1.4.1.3 "><p id="obs_03_0039__p1589932419581">Transaction date and time.</p>
</td>
</tr>
<tr id="obs_03_0039__row887619519581"><td class="cellrowborder" valign="top" width="24.177582241775823%" headers="mcps1.3.1.2.1.4.1.1 "><p id="obs_03_0039__p4788318119581">X-Trans-Id</p>
</td>
<td class="cellrowborder" valign="top" width="17.858214178582145%" headers="mcps1.3.1.2.1.4.1.2 "><p id="obs_03_0039__p5333247219581">Uuid</p>
<p id="obs_03_0039__p1023020519581">(Required)</p>
</td>
<td class="cellrowborder" valign="top" width="57.96420357964204%" headers="mcps1.3.1.2.1.4.1.3 "><p id="obs_03_0039__p2334030019581">A unique transaction identifier.</p>
<p id="obs_03_0039__p873611119581"></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0037.html">Delete Container</a></div>
</div>
</div>

38
docs/obs/api-swift/obs_03_0040.html Normal file
View File

@ -0,0 +1,38 @@
<a name="obs_03_0040"></a><a name="obs_03_0040"></a>
<h1 class="topictitle1">Examples</h1>
<div id="body1442461140568"><div class="section" id="obs_03_0040__section2201390"><h4 class="sectiontitle">Delete Empty Container</h4><p id="obs_03_0040__p61892272161737">Delete an empty <strong id="obs_03_0040__b7153442">steven</strong> container:</p>
</div>
<pre class="codeblock" id="obs_03_0040__codeblock35900084104526">curl -i -H "X-auth-token:b85044aa87eb46b88552f1dcbae411e3" http://172.28.5.31:80/v1/AUTH_09ijuyhgt675432wert56yt789i0o98u/steven -X DELETE</pre>
<pre class="screen" id="obs_03_0040__screen4496161">HTTP/1.1 204 No Content
X-Trans-Id: tx3d3e55d11af10dd917cdd-b205cb56e6
Content-Length: 0
Content-Type: text/html;charset=UTF-8
Date: Sat, 19 Sep 2015 02:37:34 GMT</pre>
<div class="section" id="obs_03_0040__section60098234144536"><h4 class="sectiontitle">Delete Non-Existing Container</h4><p id="obs_03_0040__p48068385162043">Delete the non-existing <strong id="obs_03_0040__b53936788">steve</strong> container:</p>
<pre class="codeblock" id="obs_03_0040__codeblock27069586104551">curl -i -H "X-auth-token:b85044aa87eb46b88552f1dcbae411e3" http://172.28.5.31:80/v1/AUTH_09ijuyhgt675432wert56yt789i0o98u/steve -X DELETE</pre>
</div>
<pre class="screen" id="obs_03_0040__screen46317933145020">HTTP/1.1 404 Not Found
X-Trans-Id: txbfb5fe049899729a00e6d-e304231475
Content-Type: text/html;charset=UTF-8
Date: Sat, 19 Sep 2015 02:37:04 GMT
Content-Length: 70
&lt;html&gt;&lt;h1&gt;Not Found&lt;/h1&gt;&lt;p&gt;The resource could not be found.&lt;/p&gt;&lt;/html&gt; </pre>
<div class="section" id="obs_03_0040__section35141195103039"><h4 class="sectiontitle">Delete Non-Empty Container</h4><p id="obs_03_0040__p27864526103039">Delete the non-empty <strong id="obs_03_0040__b16932901">CONTAINER</strong> container:</p>
<pre class="codeblock" id="obs_03_0040__codeblock34334688104630">curl -i -H "X-auth-token:b85044aa87eb46b88552f1dcbae411e3" http://172.28.5.31:80/v1/AUTH_09ijuyhgt675432wert56yt789i0o98u/CONTAINER -X DELETE</pre>
</div>
<pre class="screen" id="obs_03_0040__screen14610485103039">HTTP/1.1 409 Conflict
X-Trans-Id: tx920280c22ff4ec5f733a5-74a61c1cb9
Content-Type: text/html;charset=UTF-8
Date: Sat, 19 Sep 2015 02:33:28 GMT
Content-Length: 95
&lt;html&gt;&lt;h1&gt;Conflict&lt;/h1&gt;&lt;p&gt;There was a conflict when trying to complete your request.&lt;/p&gt;&lt;/html&gt;</pre>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0037.html">Delete Container</a></div>
</div>
</div>

21
docs/obs/api-swift/obs_03_0041.html Normal file
View File

@ -0,0 +1,21 @@
<a name="obs_03_0041"></a><a name="obs_03_0041"></a>
<h1 class="topictitle1">Create/Update/Delete Container Metadata</h1>
<div id="body1442459864669"><p id="obs_03_0041__p24533531">Users can send requests to create, update, or delete container metadata.</p>
<p id="obs_03_0041__p66648524105040">For details about metadata rules, see <a href="obs_03_0009.html">Naming Rules</a>.</p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="obs_03_0042.html">Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0043.html">Response</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="obs_03_0044.html">Examples</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0028.html">Operations on Containers</a></div>
</div>
</div>

232
docs/obs/api-swift/obs_03_0042.html Normal file
View File

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More