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

OBS S3 API DOC

Browse Source 
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
This commit is contained in:
zhangyue 2024-04-03 08:44:55 +00:00 committed by zuul
parent dfe65b9551
commit fd7cb2533b
4 changed files with 36 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/obs/s3api/ALL_META.TXT.json
View File

@ -1933,7 +1933,7 @@
"node_id":"en-us_topic_0125560276.xml",
"product_code":"obs",
"code":"108",
"des":"Released OnWhat's New2024-01-19Updated the following content:Updated remarks about the GET Bucket location API in the \"Compatibility of OBS REST APIs\" section.Added WORM-",
"des":"Released OnWhat's New2024-03-21Updated the following content:Updated information about the RetainUntilDate parameter and added example 2 in Configuring WORM Retention for",
"doc_type":"api_obs",
"kw":"Change History,API Reference (S3)",
"search_title":"",

2
docs/obs/s3api/CLASS.TXT.json
View File

@ -963,7 +963,7 @@
"code":"107"
},
{
"desc":"Released OnWhat's New2024-01-19Updated the following content:Updated remarks about the GET Bucket location API in the \"Compatibility of OBS REST APIs\" section.Added WORM-",
"desc":"Released OnWhat's New2024-03-21Updated the following content:Updated information about the RetainUntilDate parameter and added example 2 in Configuring WORM Retention for",
"product_code":"obs",
"title":"Change History",
"uri":"en-us_topic_0125560276.html",

34
docs/obs/s3api/en-us_topic_0000001806154009.html
View File

@ -72,12 +72,14 @@ Authorization: <em id="EN-US_TOPIC_0000001806154009__i52598685">authorization</e
</tr>
<tr id="EN-US_TOPIC_0000001806154009__row3797102133919"><td class="cellrowborder" valign="top" width="33.283328332833285%" headers="mcps1.3.7.2.1.4.1.1 "><p id="EN-US_TOPIC_0000001806154009__p19797152110399">RetainUntilDate</p>
</td>
<td class="cellrowborder" valign="top" width="33.38333833383338%" headers="mcps1.3.7.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001806154009__p8797122114397">Protection period for the object. Its value is a timestamp accurate to milliseconds, for example, <strong id="EN-US_TOPIC_0000001806154009__b2851115043815">1435728035000</strong> (corresponding to 13:20:35 on July 1, 2015).</p>
<td class="cellrowborder" valign="top" width="33.38333833383338%" headers="mcps1.3.7.2.1.4.1.2 "><p id="EN-US_TOPIC_0000001806154009__p1972554911245">Protection period for the object. The value can be a timestamp or in the ISO format.</p>
<p id="EN-US_TOPIC_0000001806154009__p20723163411226">A timestamp must be accurate to milliseconds. For example, the timestamp for 13:20:35 on July 1, 2015 should be <strong id="EN-US_TOPIC_0000001806154009__b138833491510">1435728035000</strong>.</p>
<p id="EN-US_TOPIC_0000001806154009__p12703165612419">A time zone is required in the ISO time format. For example, the ISO UTC time for 13:20:35 on July 1, 2015 should be <strong id="EN-US_TOPIC_0000001806154009__b148942030141920">2015-07-01T13:20:35Z</strong>.</p>
<div class="note" id="EN-US_TOPIC_0000001806154009__note84999367225"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001806154009__p105009367227">The value of this field must be later than the current time and can be extended but not shortened.</p>
</div></div>
<p id="EN-US_TOPIC_0000001806154009__p558629165319">Type: long</p>
<p id="EN-US_TOPIC_0000001806154009__p14372133763111">Example: <strong id="EN-US_TOPIC_0000001806154009__b1775863411406">1435728035000</strong></p>
<p id="EN-US_TOPIC_0000001806154009__p380071274616"><span style="color:#212121;">Remarks: Its value is a timestamp accurate to milliseconds in Unix time.</span></p>
<p id="EN-US_TOPIC_0000001806154009__p727205916271">Type: string</p>
<p id="EN-US_TOPIC_0000001806154009__p14372133763111">Example: <strong id="EN-US_TOPIC_0000001806154009__b1775863411406">1435728035000</strong> (a timestamp) or <strong id="EN-US_TOPIC_0000001806154009__b152622910253">2015-07-01T13:20:35Z</strong> (in the ISO format)</p>
<p id="EN-US_TOPIC_0000001806154009__p98461744182817">Remarks: timestamp value is accurate to milliseconds in Unix time.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.2.1.4.1.3 "><p id="EN-US_TOPIC_0000001806154009__p1979716217396">Yes</p>
</td>
@ -138,7 +140,8 @@ Content-Length: length</pre>
</div>
<p id="EN-US_TOPIC_0000001806154009__p3530175">For details about other errors, see <a href="en-us_topic_0125560440.html#EN-US_TOPIC_0125560440__table30733758">Table 1</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001806154009__section20891205319711"><h4 class="sectiontitle">Sample Request</h4><pre class="screen" id="EN-US_TOPIC_0000001806154009__screen814811213323">PUT /objectname?retention HTTP/1.1
<div class="section" id="EN-US_TOPIC_0000001806154009__section20891205319711"><h4 class="sectiontitle">Sample Request 1</h4><p id="EN-US_TOPIC_0000001806154009__p172337335719">Configuring the WORM protection (with the protection period specified as a timestamp) for an object.</p>
<pre class="screen" id="EN-US_TOPIC_0000001806154009__screen814811213323">PUT /objectname?retention HTTP/1.1
Host: bucketname.obs.<em id="EN-US_TOPIC_0000001806154009__i1895211304561">region</em>.example.com
Date: WED, 01 Jul 2015 02:25:05 GMT
Authorization: authorization
@ -149,13 +152,32 @@ Content-Length: 157
&lt;RetainUntilDate&gt;1435728035000&lt;/RetainUntilDate&gt;
&lt;/Retention&gt;</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001806154009__section10684516817"><h4 class="sectiontitle">Sample Response</h4><pre class="screen" id="EN-US_TOPIC_0000001806154009__screen16761132633211">HTTP/1.1 200 OK
<div class="section" id="EN-US_TOPIC_0000001806154009__section10684516817"><h4 class="sectiontitle">Sample Response 1</h4><pre class="screen" id="EN-US_TOPIC_0000001806154009__screen16761132633211">HTTP/1.1 200 OK
Server: OBS
x-amz-request-id: BF260000016435CE298386946AE4C482
x-amz-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCT9W2tcvLmMJ+plfdopaD62S0npbaRUz
Date: WED, 01 Jul 2015 02:25:06 GMT
Content-Length: 0</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001806154009__section3611149132812"><h4 class="sectiontitle">Sample Request 2</h4><p id="EN-US_TOPIC_0000001806154009__p13719493567">Configuring the WORM protection (with the protection period specified in the ISO format) for an object.</p>
<pre class="screen" id="EN-US_TOPIC_0000001806154009__screen1561112911285">PUT /objectname?retention HTTP/1.1
Host: bucketname.obs.<em id="EN-US_TOPIC_0000001806154009__i19611297289">region</em>.example.com
WED, 01 Jul 2015 02:25:06 GMT
Authorization: authorization
Content-Type: application/xml
Content-Length: 193
&lt;Retention&gt;
&lt;Mode&gt;COMPLIANCE&lt;/Mode&gt;
&lt;RetainUntilDate&gt;2015-07-01T13:20:35Z&lt;/RetainUntilDate&gt;
&lt;/Retention&gt;</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001806154009__section12611109102814"><h4 class="sectiontitle">Sample Response 2</h4><pre class="screen" id="EN-US_TOPIC_0000001806154009__screen86111598287">HTTP/1.1 200 OK
Server: OBS
x-amz-request-id: 0000018E3CC039E75306D1560F6A5B61
x-amz-id-2: 32AAAUgAIAABAAAQAAEAABAAAQAAEAABCS14XamzycaPY1tivqczu/2SI2sbVBNZ
Date: WED, 01 Jul 2015 02:25:06 GMT
Content-Length: 0</pre>
</div>
</div>
<div>
<div class="familylinks">

6
docs/obs/s3api/en-us_topic_0125560276.html
View File

@ -6,6 +6,12 @@
<th valign="bottom" align="left" id="stentry13652467194436" width="69.36%"><p id="EN-US_TOPIC_0125560276__p55763344194436">What's New</p>
</th>
</tr>
<tr id="EN-US_TOPIC_0125560276__strow1985704755015"><td valign="top" id="stentry48571147125019" headers="stentry41593773194436"><p id="EN-US_TOPIC_0125560276__p137551511171020">2024-03-21</p>
</td>
<td valign="top" id="stentry178571547125011" headers="stentry13652467194436"><p id="EN-US_TOPIC_0125560276__p13773173115516">Updated the following content:</p>
<ul id="EN-US_TOPIC_0125560276__ul197558116102"><li id="EN-US_TOPIC_0125560276__li167550112103">Updated information about the <strong id="EN-US_TOPIC_0125560276__b1072416288303">RetainUntilDate</strong> parameter and added example 2 in <a href="en-us_topic_0000001806154009.html">Configuring WORM Retention for an Object</a>.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0125560276__strow424922518459"><td valign="top" id="stentry13249132513459" headers="stentry41593773194436"><p id="EN-US_TOPIC_0125560276__p110883410430">2024-01-19</p>
</td>
<td valign="top" id="stentry524962510454" headers="stentry13652467194436"><p id="EN-US_TOPIC_0125560276__p10453155212431">Updated the following content:</p>