OBS API doc

Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>

docs/obs/api-ref/obs_04_0000.html

@@ -8,7 +8,21 @@
 </th>
 </tr>
 </thead>
-<tbody><tr id="obs_04_0000__row592217458019"><td class="cellrowborder" valign="top" width="30.3%" headers="mcps1.3.1.1.3.1.1 "><p id="obs_04_0000__p191924910014">2022-09-07</p>
+<tbody><tr id="obs_04_0000__row9809112110017"><td class="cellrowborder" valign="top" width="30.3%" headers="mcps1.3.1.1.3.1.1 "><p id="obs_04_0000__p764554411817">2023-01-30</p>
+</td>
+<td class="cellrowborder" valign="top" width="69.69999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="obs_04_0000__p1259910249010">This is the fifth official release.</p>
+<p id="obs_04_0000__p1459917241005">This issue incorporates the following changes:</p>
+<ul id="obs_04_0000__ul1514713451209"><li id="obs_04_0000__li1564418121712">Added APIs related to parallel file systems. For details, see <a href="obs_04_0092.html">Modifying an Object</a>, <a href="obs_04_0093.html">Truncating an Object</a>, and <a href="obs_04_0094.html">Renaming an Object</a>.</li><li id="obs_04_0000__li499734359">Added header <strong id="obs_04_0000__b56751346162713">x-obs-fs-file-interface</strong> in <a href="obs_04_0021.html">Creating a Bucket</a>.</li><li id="obs_04_0000__li103511519173215">Added header <strong id="obs_04_0000__b5817431122818">x-obs-bucket-type</strong> in <a href="obs_04_0020.html">Listing Buckets</a>.</li></ul>
+</td>
+</tr>
+<tr id="obs_04_0000__row7846154117195"><td class="cellrowborder" valign="top" width="30.3%" headers="mcps1.3.1.1.3.1.1 "><p id="obs_04_0000__p1884634119196">2022-10-30</p>
+</td>
+<td class="cellrowborder" valign="top" width="69.69999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="obs_04_0000__p12513372012">This is the fourth official release.</p>
+<p id="obs_04_0000__p1125133142017">This issue incorporates the following changes:</p>
+<ul id="obs_04_0000__ul1625193142019"><li id="obs_04_0000__li185782013132010">Deleted the descriptions about header <strong id="obs_04_0000__b16851212122820">x-obs-epid</strong> from <a href="obs_04_0021.html">Creating a Bucket</a> and <a href="obs_04_0023.html">Obtaining Bucket Metadata</a>.</li></ul>
+</td>
+</tr>
+<tr id="obs_04_0000__row592217458019"><td class="cellrowborder" valign="top" width="30.3%" headers="mcps1.3.1.1.3.1.1 "><p id="obs_04_0000__p191924910014">2022-09-07</p>
 </td>
 <td class="cellrowborder" valign="top" width="69.69999999999999%" headers="mcps1.3.1.1.3.1.2 "><p id="obs_04_0000__p109197491701">This is the third official release.</p>
 <p id="obs_04_0000__p139194495017">This issue incorporates the following change:</p>

docs/obs/api-ref/obs_04_0004.html

@@ -2,7 +2,7 @@
 
 <h1 class="topictitle1">Basic Concepts</h1>
 <div id="body1559715459464"><div class="section" id="obs_04_0004__section766842619411"><h4 class="sectiontitle">Basic Concepts Related to OBS APIs</h4><ul id="obs_04_0004__ul218710618517"><li id="obs_04_0004__li11265170420">Domain<p id="obs_04_0004__p1826610828"><a name="obs_04_0004__li11265170420"></a><a name="li11265170420"></a>You can register a domain with the cloud service. The domain has full access permissions for all the resources and cloud services that are subscribed under it. The domain can also reset user passwords and grant permissions to users. A domain is a payment entity. To keep the domain secure, it is recommended that you create users under the domain to perform routine management operations.</p>
-</li><li id="obs_04_0004__li15896816113116">User<p id="obs_04_0004__p589691603117"><a name="obs_04_0004__li15896816113116"></a><a name="li15896816113116"></a>You can create users under a domain on Identity and Access Management (IAM), and authorize the users with permissions required for accessing cloud services. Each IAM user has its own identity credentials (password and access keys).</p>
+</li><li id="obs_04_0004__li15896816113116">User<p id="obs_04_0004__p589691603117"><a name="obs_04_0004__li15896816113116"></a><a name="li15896816113116"></a>A user is created using a domain on Identity and Access Management (IAM) to use cloud services. Each IAM user has its own identity credentials (password and access keys).</p>
 <p id="obs_04_0004__p9896121653112"></p>
 <p id="obs_04_0004__p1390083911281">On the <strong id="obs_04_0004__b1155161692820">My Credentials</strong> page on the console, you can view the domain ID and user ID, you can also manage the access keys of the domain and IAM users.</p>
 <p id="obs_04_0004__p734065315164">Access keys of the domain and its IAM users are required for authentication when calling APIs.</p>

docs/obs/api-ref/obs_04_0005.html

@@ -25,7 +25,7 @@
 </tr>
 <tr id="obs_04_0005__row15656520821"><td class="cellrowborder" valign="top" width="39.61%" headers="mcps1.3.1.2.2.3.1.1 "><p id="obs_04_0005__p7666520126"><a href="obs_04_0023.html">Obtaining Bucket Metadata</a></p>
 </td>
-<td class="cellrowborder" valign="top" width="60.39%" headers="mcps1.3.1.2.2.3.1.2 "><p id="obs_04_0005__p175383321619">Checks whether the bucket metadata exists. You can query the information about the bucket region, storage class, OBS version number, enterprise project ID, and CORS configuration.</p>
+<td class="cellrowborder" valign="top" width="60.39%" headers="mcps1.3.1.2.2.3.1.2 "><p id="obs_04_0005__p175383321619">Checks whether the bucket metadata exists. You can query the information about the bucket region, storage class, OBS version number, and CORS configuration.</p>
 </td>
 </tr>
 <tr id="obs_04_0005__row1669020726"><td class="cellrowborder" valign="top" width="39.61%" headers="mcps1.3.1.2.2.3.1.1 "><p id="obs_04_0005__p196825201627"><a href="obs_04_0024.html">Obtaining Bucket Location</a></p>
@@ -301,6 +301,26 @@
 <td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p2791121115375">Obtains the ACL configuration of a specified object.</p>
 </td>
 </tr>
+<tr id="obs_04_0005__row425845519482"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p18740181219490"><a href="obs_04_0091.html">Modifying Object Metadata</a></p>
+</td>
+<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p1425810552488">Adds, modifies, or deletes metadata of uploaded objects.</p>
+</td>
+</tr>
+<tr id="obs_04_0005__row99230312496"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p13405131324916"><a href="obs_04_0092.html">Modifying an Object</a></p>
+</td>
+<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p39236374910">Modifies the content of an object in a specified parallel file system from the specified location.</p>
+</td>
+</tr>
+<tr id="obs_04_0005__row1720913144914"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p18251131464915"><a href="obs_04_0093.html">Truncating an Object</a></p>
+</td>
+<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p8209114497">Truncates an object in a specified parallel file system to the specified size.</p>
+</td>
+</tr>
+<tr id="obs_04_0005__row7735155824811"><td class="cellrowborder" valign="top" width="40.8%" headers="mcps1.3.4.2.2.3.1.1 "><p id="obs_04_0005__p129488145497"><a href="obs_04_0094.html">Renaming an Object</a></p>
+</td>
+<td class="cellrowborder" valign="top" width="59.199999999999996%" headers="mcps1.3.4.2.2.3.1.2 "><p id="obs_04_0005__p14735135813486">Renames an object in a specified parallel file system.</p>
+</td>
+</tr>
 </tbody>
 </table>
 </div>
@@ -312,12 +332,12 @@
 </th>
 </tr>
 </thead>
-<tbody><tr id="obs_04_0005__row53859287"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p42619108"><a href="obs_04_0097.html">Listing Initialized Multipart Tasks in a Bucket</a></p>
+<tbody><tr id="obs_04_0005__row53859287"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p42619108"><a href="obs_04_0097.html">Listing Initiated Multipart Uploads in a Bucket</a></p>
 </td>
 <td class="cellrowborder" valign="top" width="59.35%" headers="mcps1.3.5.2.2.3.1.2 "><p id="obs_04_0005__p118121583383">Queries all the multipart upload tasks that have not been merged or canceled in a bucket.</p>
 </td>
 </tr>
-<tr id="obs_04_0005__row48027654"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p33322246"><a href="obs_04_0098.html">Initializing a Multipart Task</a></p>
+<tr id="obs_04_0005__row48027654"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p33322246"><a href="obs_04_0098.html">Initiating a Multipart Upload</a></p>
 </td>
 <td class="cellrowborder" valign="top" width="59.35%" headers="mcps1.3.5.2.2.3.1.2 "><p id="obs_04_0005__p172967323016">Initiates a multipart upload task, and obtains the globally unique multipart upload task ID for subsequent operations, such as uploading, merging, and listing parts.</p>
 </td>
@@ -337,7 +357,7 @@
 <td class="cellrowborder" valign="top" width="59.35%" headers="mcps1.3.5.2.2.3.1.2 "><p id="obs_04_0005__p1429613313017">Queries information about all parts of a multipart task.</p>
 </td>
 </tr>
-<tr id="obs_04_0005__row53466558"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p16056153"><a href="obs_04_0102.html">Merging Parts into a Complete Object</a></p>
+<tr id="obs_04_0005__row53466558"><td class="cellrowborder" valign="top" width="40.65%" headers="mcps1.3.5.2.2.3.1.1 "><p id="obs_04_0005__p16056153"><a href="obs_04_0102.html">Completing a Multipart Upload</a></p>
 </td>
 <td class="cellrowborder" valign="top" width="59.35%" headers="mcps1.3.5.2.2.3.1.2 "><p id="obs_04_0005__p182961319305">Merges the specified parts into a complete object.</p>
 </td>

docs/obs/api-ref/obs_04_0007.html

@@ -16,7 +16,7 @@
 </thead>
 <tbody><tr id="obs_04_0007__row52536552"><td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.2.5.2.4.1.1 "><p id="obs_04_0007__p27602357">protocol</p>
 </td>
-<td class="cellrowborder" valign="top" width="72.72727272727273%" headers="mcps1.3.2.5.2.4.1.2 "><p id="obs_04_0007__p21198434">Protocol used for sending requests, which can be either HTTP or HTTPS. HTTPS is a protocol that ensures secure access to resources. OBS supports both HTTP and HTTPS.</p>
+<td class="cellrowborder" valign="top" width="72.72727272727273%" headers="mcps1.3.2.5.2.4.1.2 "><p id="obs_04_0007__p21198434">Protocol used for sending requests, which can be either HTTP or HTTPS. HTTPS is a protocol that ensures secure access to resources.</p>
 </td>
 <td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.2.5.2.4.1.3 "><p id="obs_04_0007__p39351575">Yes</p>
 </td>
@@ -37,8 +37,8 @@
 </tr>
 <tr id="obs_04_0007__row53201908"><td class="cellrowborder" valign="top" width="14.141414141414144%" headers="mcps1.3.2.5.2.4.1.1 "><p id="obs_04_0007__p14387307">port</p>
 </td>
-<td class="cellrowborder" valign="top" width="72.72727272727273%" headers="mcps1.3.2.5.2.4.1.2 "><p id="obs_04_0007__p24521247">Port enabled for protocols used for sending requests. The value varies with software server deployment. If no port number is specified, the protocol uses the default value. Each transmission protocol has its default port number. For example, HTTP uses port number <strong id="obs_04_0007__b1444577227162034">80</strong> and HTTPS uses port number <strong id="obs_04_0007__b41545509162034">443</strong> by default.</p>
-<p id="obs_04_0007__p25031604">In OBS, HTTP port number is <strong id="obs_04_0007__b16741611132511">80</strong> and that of HTTPS is <strong id="obs_04_0007__b12904131772518">443</strong>.</p>
+<td class="cellrowborder" valign="top" width="72.72727272727273%" headers="mcps1.3.2.5.2.4.1.2 "><p id="obs_04_0007__p24521247">Port enabled for protocols used for sending requests. The value varies with software server deployment. If no port number is specified, the protocol uses the default value. Each transmission protocol has its default port number.</p>
+<p id="obs_04_0007__p25031604">In OBS, the default HTTP port number is <strong id="obs_04_0007__b10573105513402">80</strong> and that of HTTPS is <strong id="obs_04_0007__b1157335524014">443</strong>.</p>
 </td>
 <td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.2.5.2.4.1.3 "><p id="obs_04_0007__p14294078">No</p>
 </td>
@@ -131,7 +131,7 @@
 <td class="cellrowborder" valign="top" width="58.87%" headers="mcps1.3.4.3.2.4.1.2 "><p id="obs_04_0007__p601777">The message length (excluding headers) defined in RFC 2616</p>
 <p id="obs_04_0007__p5415993">Type: string</p>
 <p id="obs_04_0007__p48743940">No default value.</p>
-<p id="obs_04_0007__p36042284">Conditional: required for PUT requests and those requests that load XML content.</p>
+<p id="obs_04_0007__p36042284">Conditional: optional for PUT requests, but mandatory for the requests that load XML content</p>
 </td>
 <td class="cellrowborder" valign="top" width="20.75%" headers="mcps1.3.4.3.2.4.1.3 "><p id="obs_04_0007__p33743900">Conditionally required</p>
 </td>
@@ -157,7 +157,7 @@
 </tr>
 <tr id="obs_04_0007__row64573848"><td class="cellrowborder" valign="top" width="20.380000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="obs_04_0007__p63099185">Host</p>
 </td>
-<td class="cellrowborder" valign="top" width="58.87%" headers="mcps1.3.4.3.2.4.1.2 "><p id="obs_04_0007__p97201251192612">The host address. For example, <strong id="obs_04_0007__b84235270615416">bucketname.obs.<em id="obs_04_0007__i842352697154112">region</em>.example.com</strong>.</p>
+<td class="cellrowborder" valign="top" width="58.87%" headers="mcps1.3.4.3.2.4.1.2 "><p id="obs_04_0007__p97201251192612">The host address, for example, <em id="obs_04_0007__i091915516116">bucketname</em><strong id="obs_04_0007__b103833581118">.obs.</strong><em id="obs_04_0007__i1503348161018">region</em><strong id="obs_04_0007__b135035483101">.example.com</strong>.</p>
 <p id="obs_04_0007__p29734368">Type: string</p>
 <p id="obs_04_0007__p66282721">No default value.</p>
 </td>

docs/obs/api-ref/obs_04_0012.html

@@ -90,7 +90,7 @@ Signature = Base64( HMAC-SHA1( YourSecretAccessKeyID, StringToSign ) )</pre>
 </tbody>
 </table>
 </div>
-<p id="obs_04_0012__p30406164114831">The policy conditions can be matched in the following ways:</p>
+<p id="obs_04_0012__p30406164114831">The table below describes how policy conditions can be matched.</p>
 
 <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0012__table49086577114935" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Policy condition matching methods</caption><thead align="left"><tr id="obs_04_0012__row30029674114935"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.9.5.2.3.1.1"><p id="obs_04_0012__p38977014114935">Matching Method</p>
 </th>
@@ -127,7 +127,7 @@ Signature = Base64( HMAC-SHA1( YourSecretAccessKeyID, StringToSign ) )</pre>
 </div>
 <div class="note" id="obs_04_0012__note114221355114513"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_04_0012__p1898164683720">A policy is in the JSON format. Conditions can be put in curly brackets {} and square brackets []. The key and value elements of the table are written in the curly brackets {}, which are separated by colons (:). The square brackets [] contain the condition type, key, and value. These three items are separated by commas (,). The dollar sign ($) in front of the key indicates that the key is a variable.</p>
 </div></div>
-<p id="obs_04_0012__p4782727211850">The following characters must be escaped in a policy:</p>
+<p id="obs_04_0012__p4782727211850">The table below lists the characters that must be escaped in a policy.</p>
 
 <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="obs_04_0012__table35624816115455" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Characters that must be escaped in a policy</caption><thead align="left"><tr id="obs_04_0012__row56560712115455"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.9.8.2.3.1.1"><p id="obs_04_0012__p56433267115455">Character After Escape</p>
 </th>

docs/obs/api-ref/obs_04_0019.html

@@ -10,6 +10,8 @@
 </li>
 <li class="ulchildlink"><strong><a href="obs_04_0022.html">Listing Objects in a Bucket</a></strong><br>
 </li>
+<li class="ulchildlink"><strong><a href="obs_04_0160.html">Listing Objects in a Bucket (V2)</a></strong><br>
+</li>
 <li class="ulchildlink"><strong><a href="obs_04_0023.html">Obtaining Bucket Metadata</a></strong><br>
 </li>
 <li class="ulchildlink"><strong><a href="obs_04_0024.html">Obtaining Bucket Location</a></strong><br>