SFS HPC API DOC

Reviewed-by: Miskanin, Jan <jan.miskanin@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>

docs/sfs/api-ref/ErrorCode.html

@@ -108,7 +108,7 @@
 </td>
 <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.3 "><p id="ErrorCode__p18417112614351">Name has existed</p>
 </td>
-<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.4 "><p id="ErrorCode__p13685123310354">The file system name already exists.</p>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.4 "><p id="ErrorCode__p13685123310354">File system name already exists.</p>
 </td>
 <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.5 "><p id="ErrorCode__p6610104373510">Use valid parameters and try again.</p>
 </td>
@@ -421,6 +421,28 @@
 <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.5 "><p id="ErrorCode__p1679793611019">Apply for a higher quota.</p>
 </td>
 </tr>
+<tr id="ErrorCode__row6833193932312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.1 "><p id="ErrorCode__p1983319392230">400</p>
+</td>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.2 "><p id="ErrorCode__p1583323932314">SFS.TURBO.0041</p>
+</td>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.3 "><p id="ErrorCode__p38331539152318">Operation is not allowed</p>
+</td>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.4 "><p id="ErrorCode__p18386133116324">File system version too early.</p>
+</td>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.5 "><p id="ErrorCode__p88331390233">Contact technical support.</p>
+</td>
+</tr>
+<tr id="ErrorCode__row455793316231"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.1 "><p id="ErrorCode__p25571833132317">404</p>
+</td>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.2 "><p id="ErrorCode__p4799113617352">SFS.TURBO.0042</p>
+</td>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.3 "><p id="ErrorCode__p4558113319237">Invalid NIC ID</p>
+</td>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.4 "><p id="ErrorCode__p5558183312319">The specified NIC ID is not found or is empty.</p>
+</td>
+<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.5 "><p id="ErrorCode__p65961846155315">Use valid parameters and try again.</p>
+</td>
+</tr>
 <tr id="ErrorCode__row1797436131010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.1 "><p id="ErrorCode__p1879783619107">400</p>
 </td>
 <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.2 "><p id="ErrorCode__p187979368107">SFS.TURBO.0100</p>

docs/sfs/api-ref/en-us_topic_0000001537230113.html

@@ -1,19 +0,0 @@
-<a name="EN-US_TOPIC_0000001537230113"></a><a name="EN-US_TOPIC_0000001537230113"></a>
-
-
-  <h1 class="topictitle1">Name Management</h1>
-
-  <div id="body0000001537230113"><p id="EN-US_TOPIC_0000001537230113__p8060118"></p>
-</div>
-
-<div>
-<ul class="ullinks">
-<li class="ulchildlink"><strong><a href="en-us_topic_0000001537629949.html">Changing the Name of a File System</a></strong><br>
-</li>
-</ul>
-
-<div class="familylinks">
-<div class="parentlink"><strong>Parent topic:</strong> <a href="sfs_02_0049.html">SFS Turbo APIs</a></div>
-</div>
-</div>
-

docs/sfs/api-ref/en-us_topic_0000001663116961.html

@@ -1,23 +0,0 @@
-<a name="EN-US_TOPIC_0000001663116961"></a><a name="EN-US_TOPIC_0000001663116961"></a>
-
-<h1 class="topictitle1">Permissions Management</h1>
-<div id="body0000001663116961"></div>
-<div>
-<ul class="ullinks">
-<li class="ulchildlink"><strong><a href="en-us_topic_0000001663156945.html">Creating a Permission Rule</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="en-us_topic_0000001614397248.html">Querying Permission Rules of a File System</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="en-us_topic_0000001662877113.html">Querying a Permission Rule by ID</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="en-us_topic_0000001662997101.html">Modifying a Permission Rule</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="en-us_topic_0000001614557076.html">Deleting a Permissions Rule</a></strong><br>
-</li>
-</ul>
-
-<div class="familylinks">
-<div class="parentlink"><strong>Parent topic:</strong> <a href="sfs_02_0049.html">SFS Turbo APIs</a></div>
-</div>
-</div>
-

docs/sfs/api-ref/sfs_02_0001.html

@@ -4,5 +4,54 @@
 <div id="body8662426"><p id="sfs_02_0001__p1645204610259">Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://<em id="sfs_02_0001__aca1eab249b8e49e7a4c208db8c1c484f">Endpoint/uri</em>. In the URL, <strong id="sfs_02_0001__b5754736910259">uri</strong> indicates the resource path, that is, the API access path.</p>
 <p id="sfs_02_0001__p4816427810259">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by <strong id="sfs_02_0001__b3082532510259">Application/json</strong>.</p>
 <p id="sfs_02_0001__p188289482118">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents" target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
+<p id="sfs_02_0001__p1622912567545">An endpoint is the <strong id="sfs_02_0001__b3883190111215">request address</strong> for calling an API. Endpoints vary depending on services and regions.</p>
+
+<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0001__table10404183115620" frame="border" border="1" rules="all"><caption><b>Table 1 </b>SFS endpoint information</caption><thead align="left"><tr id="sfs_02_0001__row440411345616"><th align="left" class="cellrowborder" valign="top" width="21.98219821982198%" id="mcps1.3.5.2.5.1.1"><p id="sfs_02_0001__p1719113455551">Service Name</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="21.402140214021404%" id="mcps1.3.5.2.5.1.2"><p id="sfs_02_0001__p17256191310020">Region</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="34.333433343334335%" id="mcps1.3.5.2.5.1.3"><p id="sfs_02_0001__p134041333561">URL</p>
+</th>
+<th align="left" class="cellrowborder" valign="top" width="22.282228222822283%" id="mcps1.3.5.2.5.1.4"><p id="sfs_02_0001__p440423125618">Protocol</p>
+</th>
+</tr>
+</thead>
+<tbody><tr id="sfs_02_0001__row14049310568"><td class="cellrowborder" rowspan="2" valign="top" width="21.98219821982198%" headers="mcps1.3.5.2.5.1.1 "><p id="sfs_02_0001__p9191194518557">Scalable File Service Turbo</p>
+</td>
+<td class="cellrowborder" valign="top" width="21.402140214021404%" headers="mcps1.3.5.2.5.1.2 "><p id="sfs_02_0001__p1824019460583">eu-de</p>
+</td>
+<td class="cellrowborder" valign="top" width="34.333433343334335%" headers="mcps1.3.5.2.5.1.3 "><p id="sfs_02_0001__p9240164615584">sfs-turbo.eu-de.otc.t-systems.com</p>
+</td>
+<td class="cellrowborder" valign="top" width="22.282228222822283%" headers="mcps1.3.5.2.5.1.4 "><p id="sfs_02_0001__p114047317569">HTTPS</p>
+</td>
+</tr>
+<tr id="sfs_02_0001__row281913541446"><td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.1 "><p id="sfs_02_0001__p9250205418584">eu-nl</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.2 "><p id="sfs_02_0001__p225095435811">sfs-turbo.eu-nl.otc.t-systems.com</p>
+</td>
+<td class="cellrowborder" valign="top" headers="mcps1.3.5.2.5.1.3 "><p id="sfs_02_0001__p313029135710">HTTPS</p>
+</td>
+</tr>
+<tr id="sfs_02_0001__row24047315569"><td class="cellrowborder" valign="top" width="21.98219821982198%" headers="mcps1.3.5.2.5.1.1 "><p id="sfs_02_0001__p2095145535713">Scalable File Service</p>
+</td>
+<td class="cellrowborder" valign="top" width="21.402140214021404%" headers="mcps1.3.5.2.5.1.2 "><p id="sfs_02_0001__p144997685912">eu-de</p>
+</td>
+<td class="cellrowborder" valign="top" width="34.333433343334335%" headers="mcps1.3.5.2.5.1.3 "><p id="sfs_02_0001__p1349986105916">sfs.eu-de.otc.t-systems.com</p>
+</td>
+<td class="cellrowborder" valign="top" width="22.282228222822283%" headers="mcps1.3.5.2.5.1.4 "><p id="sfs_02_0001__p6134998577">HTTPS</p>
+</td>
+</tr>
+<tr id="sfs_02_0001__row1336178144313"><td class="cellrowborder" valign="top" width="21.98219821982198%" headers="mcps1.3.5.2.5.1.1 "><p id="sfs_02_0001__p20361168144316">SFS 3.0 Capacity-Oriented</p>
+</td>
+<td class="cellrowborder" valign="top" width="21.402140214021404%" headers="mcps1.3.5.2.5.1.2 "><p id="sfs_02_0001__p1636118844317">eu-de</p>
+</td>
+<td class="cellrowborder" valign="top" width="34.333433343334335%" headers="mcps1.3.5.2.5.1.3 "><p id="sfs_02_0001__p536110814436">sfs3.eu-de.otc.t-systems.com</p>
+</td>
+<td class="cellrowborder" valign="top" width="22.282228222822283%" headers="mcps1.3.5.2.5.1.4 "><p id="sfs_02_0001__p4668111724317">HTTPS</p>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
 </div>
 

docs/sfs/api-ref/sfs_02_0008.html

@@ -0,0 +1,15 @@
+<a name="sfs_02_0008"></a><a name="sfs_02_0008"></a>
+
+<h1 class="topictitle1">Calling APIs</h1>
+<div id="body1559725760179"></div>
+<div>
+<ul class="ullinks">
+<li class="ulchildlink"><strong><a href="sfs_02_0009.html">Making an API Request</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="sfs_02_0011.html">Authentication</a></strong><br>
+</li>
+<li class="ulchildlink"><strong><a href="sfs_02_0012.html">Response</a></strong><br>
+</li>
+</ul>
+</div>
+

docs/sfs/api-ref/sfs_02_0011.html

@@ -0,0 +1,57 @@
+<a name="sfs_02_0011"></a><a name="sfs_02_0011"></a>
+
+<h1 class="topictitle1">Authentication</h1>
+<div id="body1559725760180"><div class="p" id="sfs_02_0011__en-us_topic_0121671869_p26613555143846">Requests for calling an API can be authenticated using either of the following methods:<ul id="sfs_02_0011__en-us_topic_0121671869_ul38195410143846"><li id="sfs_02_0011__en-us_topic_0121671869_li61384639143846">AK/SK authentication: Requests are encrypted using AK/SK pairs. AK/SK authentication is recommended because it is more secure than token authentication.</li><li id="sfs_02_0011__en-us_topic_0121671869_li8214375143846">Token authentication: Requests are authenticated using tokens.</li></ul>
+</div>
+<div class="section" id="sfs_02_0011__en-us_topic_0121671869_section5887143815518"><h4 class="sectiontitle">AK/SK Authentication</h4><div class="note" id="sfs_02_0011__en-us_topic_0121671869_note26801820183918"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0011__en-us_topic_0121671869_p12680102053918">AK/SK authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token authentication is recommended.</p>
+</div></div>
+<p id="sfs_02_0011__en-us_topic_0121671869_p171211559122516">In AK/SK authentication, AK/SK is used to sign requests and the signature is then added to the requests for authentication.</p>
+<ul id="sfs_02_0011__en-us_topic_0121671869_ul9783543561"><li id="sfs_02_0011__en-us_topic_0121671869_li8787541560">AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.</li><li id="sfs_02_0011__en-us_topic_0121671869_li47917548569">SK: secret access key, which is used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.</li></ul>
+<p id="sfs_02_0011__en-us_topic_0121671869_p1866949103516">In AK/SK authentication, you can use an AK/SK to sign requests based on the signature algorithm or using the signing SDK. </p>
+<div class="note" id="sfs_02_0011__en-us_topic_0121671869_note1225618420315"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0011__en-us_topic_0121671869_p1325674263111">The signing SDK is only used for signing requests and is different from the SDKs provided by services.</p>
+</div></div>
+</div>
+<div class="section" id="sfs_02_0011__en-us_topic_0121671869_section2417768214391"><h4 class="sectiontitle">Token Authentication</h4><div class="note" id="sfs_02_0011__en-us_topic_0121671869_note133321911123"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0011__en-us_topic_0121671869_p1254514271026">The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.</p>
+</div></div>
+<p id="sfs_02_0011__en-us_topic_0121671869_p24084172174">A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API. You can obtain a token by calling the <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">Obtaining User Token</a> API.</p>
+<p id="sfs_02_0011__en-us_topic_0121671869_p18703477214">IMS is a project-level service. When you call the API, set <strong id="sfs_02_0011__en-us_topic_0121671869_b1442622113014">auth.scope</strong> in the request body to <strong id="sfs_02_0011__en-us_topic_0121671869_b9433321123019">project</strong>.</p>
+<p id="sfs_02_0011__en-us_topic_0121671869_p5296182518188"></p>
+<pre class="screen" id="sfs_02_0011__en-us_topic_0121671869_screen1830175615316">{
+    "auth": {
+        "identity": {
+            "methods": [
+                "password"
+            ],
+            "password": {
+                "user": {
+                    "name": "<em id="sfs_02_0011__en-us_topic_0121671869_i315217719194"><strong id="sfs_02_0011__en-us_topic_0121671869_b14500116161919">username</strong></em>",   // IAM user name
+                    "password": <em id="sfs_02_0011__en-us_topic_0121671869_i15727114912154"><strong id="sfs_02_0011__en-us_topic_0121671869_b87274494151">$ADMIN_PASS</strong></em>,  //IAM user password. You are advised to store it in ciphertext in the configuration file or an environment variable and decrypt it when needed to ensure security.
+                    "domain": {
+                        "name": "<em id="sfs_02_0011__en-us_topic_0121671869_i1560271681911"><strong id="sfs_02_0011__en-us_topic_0121671869_b17173191614194">domainname</strong></em>"  // Name of the domain to which the IAM user belongs
+                    }
+                }
+            }
+        },
+        <strong id="sfs_02_0011__en-us_topic_0121671869_b28781733191612">"scope": {</strong>
+            <strong id="sfs_02_0011__en-us_topic_0121671869_b18664134414161">"project": {</strong>
+                <strong id="sfs_02_0011__en-us_topic_0121671869_b145484513165">"name": "<em id="sfs_02_0011__en-us_topic_0121671869_i4548165119166">xxxxxxxx</em>"</strong>    // Project name
+            <strong id="sfs_02_0011__en-us_topic_0121671869_b5551165531613">}</strong>
+        <strong id="sfs_02_0011__en-us_topic_0121671869_b18740155861611">}</strong>
+    }
+}</pre>
+<p id="sfs_02_0011__en-us_topic_0121671869_p9691122114266">After a token is obtained, the <strong id="sfs_02_0011__en-us_topic_0121671869_b147976273481">X-Auth-Token</strong> header field must be added to requests to specify the token when calling other APIs. For example, if the token is <span class="parmvalue" id="sfs_02_0011__en-us_topic_0121671869_parmvalue36546471362"><b>ABCDEFJ....</b></span>, <span class="parmvalue" id="sfs_02_0011__en-us_topic_0121671869_parmvalue10655144717611"><b>X-Auth-Token: ABCDEFJ....</b></span> can be added to a request as follows:</p>
+<div class="codecoloring" codetype="Java" id="sfs_02_0011__en-us_topic_0121671869_screen11189101154015"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
+<span class="normal">2</span>
+<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">POST</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{{endpoint}}/v3/auth/projects</span>
+<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span><span class="w"> </span><span class="n">application</span><span class="o">/</span><span class="n">json</span>
+<span class="n">X</span><span class="o">-</span><span class="n">Auth</span><span class="o">-</span><span class="n">Token</span><span class="p">:</span><span class="w"> </span><span class="n">ABCDEFJ</span><span class="p">....</span>
+</pre></div></td></tr></table></div>
+</div>
+</div>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="sfs_02_0008.html">Calling APIs</a></div>
+</div>
+</div>
+

docs/sfs/api-ref/sfs_02_0012.html

@@ -0,0 +1,41 @@
+<a name="sfs_02_0012"></a><a name="sfs_02_0012"></a>
+
+<h1 class="topictitle1">Response</h1>
+<div id="body1559725760180"><div class="section" id="sfs_02_0012__en-us_topic_0170155703_section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="sfs_02_0012__en-us_topic_0170155703_p4624111624411">After sending a request, you will receive a response, including a status code, response header, and response body.</p>
+<p id="sfs_02_0012__en-us_topic_0170155703_p124381044137">A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see <a href="sfs_02_0089.html">Status Codes</a>.</p>
+<p id="sfs_02_0012__en-us_topic_0170155703_p2861496519">For example, if status code <span class="parmvalue" id="sfs_02_0012__en-us_topic_0170155703_parmvalue343043992219"><b>201</b></span> is returned for calling the API used to , the request is successful.</p>
+</div>
+<div class="section" id="sfs_02_0012__en-us_topic_0170155703_en-us_topic_0113746487_section61333484715"><h4 class="sectiontitle">Response Header</h4><p id="sfs_02_0012__en-us_topic_0170155703_p384320471837">Similar to a request, a response also has a header, for example, <strong id="sfs_02_0012__en-us_topic_0170155703_b1985552133610">Content-Type</strong>.</p>
+<p id="sfs_02_0012__en-us_topic_0170155703_p4430113619484"><a href="#sfs_02_0012__en-us_topic_0170155703_fig4865141011511">Figure 1</a> shows the response header fields for the API used to . The <strong id="sfs_02_0012__en-us_topic_0170155703_b15219862413">X-Subject-Token</strong> header field is the desired user token. This token can then be used to authenticate the calling of other APIs.</p>
+<div class="note" id="sfs_02_0012__en-us_topic_0170155703_note29537174719"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0012__en-us_topic_0170155703_p595414144718">For security purposes, you are advised to set the token in ciphertext in configuration files or environment variables and decrypt it when using it.</p>
+</div></div>
+<div class="fignone" id="sfs_02_0012__en-us_topic_0170155703_fig4865141011511"><a name="sfs_02_0012__en-us_topic_0170155703_fig4865141011511"></a><a name="en-us_topic_0170155703_fig4865141011511"></a><span class="figcap"><b>Figure 1 </b>Header fields of the response to the request for obtaining a user token</span><br><span><img id="sfs_02_0012__en-us_topic_0170155703_image1197523984615" src="en-us_image_0000001773129352.png" title="Click to enlarge" class="imgResize"></span></div>
+</div>
+<div class="section" id="sfs_02_0012__en-us_topic_0170155703_en-us_topic_0113746487_section2045571671419"><h4 class="sectiontitle">(Optional) Response Body</h4><p id="sfs_02_0012__en-us_topic_0170155703_en-us_topic_0113746487_p64711881416">The body of a response is often returned in a structured format (for example, JSON or XML) as specified in the <strong id="sfs_02_0012__en-us_topic_0170155703_b13357143052813">Content-Type</strong> header field. The response body transfers content except the response header.</p>
+</div>
+<p id="sfs_02_0012__en-us_topic_0170155703_p157041652367">The following is part of the response body for the API used to .</p>
+<p id="sfs_02_0012__en-us_topic_0170155703_p127537375412">If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.</p>
+<div class="codecoloring" codetype="Java" id="sfs_02_0012__en-us_topic_0170155703_screen102091730125513"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
+<span class="normal">2</span>
+<span class="normal">3</span>
+<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
+<span class="w">    </span><span class="s">&quot;error_msg&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;The request message format is invalid.&quot;</span><span class="p">,</span>
+<span class="w">    </span><span class="s">&quot;error_code&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;IMG.0001&quot;</span>
+<span class="p">}</span>
+</pre></div></td></tr></table></div>
+</div>
+<p id="sfs_02_0012__en-us_topic_0170155703_p1589911464018">In the response body, <strong id="sfs_02_0012__en-us_topic_0170155703_b1022472112479">error_code</strong> is an error code, and <strong id="sfs_02_0012__en-us_topic_0170155703_b18234321154714">error_msg</strong> provides information about the error.</p>
+</div>
+<div>
+<div class="familylinks">
+<div class="parentlink"><strong>Parent topic:</strong> <a href="sfs_02_0008.html">Calling APIs</a></div>
+</div>
+</div>
+
+
+<script language="JavaScript">
+<!--
+image_size('.imgResize');
+var msg_imageMax = "view original image";
+var msg_imageClose = "close";
+//--></script>

docs/sfs/api-ref/sfs_02_0016.html

@@ -1,7 +1,8 @@
 <a name="sfs_02_0016"></a><a name="sfs_02_0016"></a>
 
 <h1 class="topictitle1">SFS Capacity-Oriented APIs</h1>
-<div id="body1539075757636"></div>
+<div id="body1539075757636"><p id="sfs_02_0016__p733637104414"></p>
+</div>
 <div>
 <ul class="ullinks">
 <li class="ulchildlink"><strong><a href="sfs_02_0017.html">API Version Queries</a></strong><br>

docs/sfs/api-ref/sfs_02_0026.html

@@ -102,12 +102,13 @@
 </table>
 </div>
 </li></ul>
-<ul id="sfs_02_0026__u674772b7ff694a1e931dc0a9c4e22f86"><li id="sfs_02_0026__lfcd4b4fc10f2482aa44c6ab6b9cc10eb">Example request<pre class="screen" id="sfs_02_0026__s66d40af8a1444c64921a4cb5415f7365">{
+<ul id="sfs_02_0026__u674772b7ff694a1e931dc0a9c4e22f86"><li id="sfs_02_0026__lfcd4b4fc10f2482aa44c6ab6b9cc10eb">Example request<div class="p" id="sfs_02_0026__p1232381864911"><a name="sfs_02_0026__lfcd4b4fc10f2482aa44c6ab6b9cc10eb"></a><a name="lfcd4b4fc10f2482aa44c6ab6b9cc10eb"></a>Modifying a shared file system (with the file system name changed to <strong id="sfs_02_0026__b1683825191111">testshare</strong> and description to <strong id="sfs_02_0026__b135111789117">test</strong>):<pre class="screen" id="sfs_02_0026__s66d40af8a1444c64921a4cb5415f7365">{
     "share": {
         "display_name": "testshare",
         "display_description": "test"
     }
 }</pre>
+</div>
 </li></ul>
 </div>
 <div class="section" id="sfs_02_0026__sbbc5e0545135406aae43b288bf052255"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0026__u2ff0b2946244412baeb4b062da6f8e7c"><li id="sfs_02_0026__l236162ec749645a19eda2ada7aa38c8f">Parameter description
@@ -198,7 +199,7 @@
 </td>
 <td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0026__p191361718428">String</p>
 </td>
-<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0026__p913617713429">(Supported by API versions from v2.31 to v2.42) Specifies the ID of a consistency group. This parameter is reserved, because consistency groups are not supported currently.</p>
+<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0026__p913617713429">(Supported by API versions from v2.31 to v2.42.) Specifies the ID of a consistency group. This parameter is reserved, because consistency groups are not supported currently.</p>
 </td>
 </tr>
 <tr id="sfs_02_0026__en-us_topic_0064390794_row14146850115432"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0026__en-us_topic_0064390794_p43647722115456">project_id</p>
@@ -233,14 +234,14 @@
 </td>
 <td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0026__en-us_topic_0064390794_p4870772510316">Boolean</p>
 </td>
-<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0026__en-us_topic_0064390794_p5301165710316">(Supported by API versions from v2.11 to v2.42) Specifies whether any replication exists. This parameter is reserved, because replication is not supported currently.</p>
+<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0026__en-us_topic_0064390794_p5301165710316">(Supported by API versions from v2.11 to v2.42.) Specifies whether any replication exists. This parameter is reserved, because replication is not supported currently.</p>
 </td>
 </tr>
 <tr id="sfs_02_0026__en-us_topic_0064390794_row48841735810"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0026__en-us_topic_0064390794_p1388510311817">replication_type</p>
 </td>
 <td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0026__p161371471421">String</p>
 </td>
-<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0026__p21373711424">(Supported by API versions from v2.11 to v2.42) Specifies the replication type. This parameter is reserved, because replication is not supported currently.</p>
+<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0026__p21373711424">(Supported by API versions from v2.11 to v2.42.) Specifies the replication type. This parameter is reserved, because replication is not supported currently.</p>
 </td>
 </tr>
 <tr id="sfs_02_0026__en-us_topic_0064390794_row38372338115421"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0026__en-us_topic_0064390794_p61202789115456">description</p>
@@ -324,7 +325,7 @@
 </td>
 <td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0026__en-us_topic_0064390794_p2442773012115">Boolean</p>
 </td>
-<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0026__p111398774211">(Supported by API versions from v2.8 to v2.42). Specifies whether a file system can be publicly seen. If it is set to <strong id="sfs_02_0026__b1783672333213">true</strong>, the file system can be seen publicly. If it is set to <strong id="sfs_02_0026__b138382237325">false</strong>, the file system can be seen privately. The default value is <strong id="sfs_02_0026__b583818239324">false</strong>.</p>
+<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0026__p111398774211">(Supported by API versions from v2.8 to v2.42.) Specifies whether a file system can be publicly seen. If it is set to <strong id="sfs_02_0026__b1783672333213">true</strong>, the file system can be seen publicly. If it is set to <strong id="sfs_02_0026__b138382237325">false</strong>, the file system can be seen privately. The default value is <strong id="sfs_02_0026__b583818239324">false</strong>.</p>
 </td>
 </tr>
 <tr id="sfs_02_0026__en-us_topic_0064390794_row138591369913"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0026__p121392744219">source_share_group_snapshot_member_id</p>

docs/sfs/api-ref/sfs_02_0029.html

@@ -132,7 +132,7 @@
 </li></ul>
 </div>
 <ul id="sfs_02_0029__ul1188471420521"><li id="sfs_02_0029__li98861214175218">Example request (IP address-based authorization)<p id="sfs_02_0029__p1096922113134"><a name="sfs_02_0029__li98861214175218"></a><a name="li98861214175218"></a>POST  /v2/{project_id}/shares/{share_id}/action?vpc_ip_base_acl=enable</p>
-<p id="sfs_02_0029__p7699142213170">NFS file system:</p>
+<p id="sfs_02_0029__p7699142213170">Adding a file system access rule (value of the rule parameter <strong id="sfs_02_0029__b71531455141320">0560a527-0e77-40a6-aa3b-110beecad368#127.0.0.1#1#all_squash,root_squash</strong>):</p>
 <pre class="screen" id="sfs_02_0029__screen129031143121711">{ 
     "allow_access": { 
         "access_to": "0560a527-0e77-40a6-aa3b-110beecad368#127.0.0.1#1#all_squash,root_squash", 
@@ -227,14 +227,14 @@
 </td>
 <td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0029__p5201165514816">String</p>
 </td>
-<td class="cellrowborder" valign="top" width="56.98%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0029__p72011155134814">Specifies the time when the access rule was created. This parameter exists only when the value of <strong id="sfs_02_0029__b161772143">X-Openstack-Manila-Api-Version</strong> in the request header is greater than or equal to 2.33.</p>
+<td class="cellrowborder" valign="top" width="56.98%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0029__p72011155134814">Specifies the time when the access rule was created. This parameter exists only when the value of <strong id="sfs_02_0029__b789430517">X-Openstack-Manila-Api-Version</strong> in the request header is greater than or equal to 2.33.</p>
 </td>
 </tr>
 <tr id="sfs_02_0029__row147971753154819"><td class="cellrowborder" valign="top" width="21.029999999999998%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0029__p1463583132213">updated_at</p>
 </td>
 <td class="cellrowborder" valign="top" width="21.990000000000002%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0029__p1520115553482">String</p>
 </td>
-<td class="cellrowborder" valign="top" width="56.98%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0029__p1720135512481">Specifies the time when the access rule was updated. This parameter exists only when the value of <strong id="sfs_02_0029__b720974880">X-Openstack-Manila-Api-Version</strong> in the request header is greater than or equal to 2.33.</p>
+<td class="cellrowborder" valign="top" width="56.98%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0029__p1720135512481">Specifies the time when the access rule was updated. This parameter exists only when the value of <strong id="sfs_02_0029__b393542902">X-Openstack-Manila-Api-Version</strong> in the request header is greater than or equal to 2.33.</p>
 </td>
 </tr>
 </tbody>

docs/sfs/api-ref/sfs_02_0030.html

@@ -88,11 +88,12 @@
 </table>
 </div>
 </li></ul>
-<ul id="sfs_02_0030__uba0932b38c6b46ac9d78172bd3e913ba"><li id="sfs_02_0030__l348d3e7515f648d49ec99af0e721d826">Example request<pre class="screen" id="sfs_02_0030__sbb52b69998c045cbaaf1818ea9e65582">{
+<ul id="sfs_02_0030__uba0932b38c6b46ac9d78172bd3e913ba"><li id="sfs_02_0030__l348d3e7515f648d49ec99af0e721d826">Example request<div class="p" id="sfs_02_0030__p1316830125814"><a name="sfs_02_0030__l348d3e7515f648d49ec99af0e721d826"></a><a name="l348d3e7515f648d49ec99af0e721d826"></a>Deleting a file system access rule (rule ID: <strong id="sfs_02_0030__b205299514353">418e3cf4-08c3-4ed2-a29a-ceffa346b3b8</strong>):<pre class="screen" id="sfs_02_0030__sbb52b69998c045cbaaf1818ea9e65582">{
     "os-deny_access": {
         "access_id": "418e3cf4-08c3-4ed2-a29a-ceffa346b3b8"
     }
 }</pre>
+</div>
 </li></ul>
 </div>
 <div class="section" id="sfs_02_0030__s21a46342638f4cacb04ad589d49cf060"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0030__en-us_topic_0064390799_ul31903028"><li id="sfs_02_0030__en-us_topic_0064390799_li18691797">Parameter description</li></ul>

docs/sfs/api-ref/sfs_02_0034.html

@@ -86,11 +86,12 @@
 </table>
 </div>
 </li></ul>
-<ul id="sfs_02_0034__u434deb31f4cf492a8cb7b55513fa65f2"><li id="sfs_02_0034__en-us_topic_0076901182_li21151286">Example request<pre class="screen" id="sfs_02_0034__se4447b9628bd41c9bfa67c3a8dfe3238">{
+<ul id="sfs_02_0034__u434deb31f4cf492a8cb7b55513fa65f2"><li id="sfs_02_0034__en-us_topic_0076901182_li21151286">Example request<div class="p" id="sfs_02_0034__p20421330105817"><a name="sfs_02_0034__en-us_topic_0076901182_li21151286"></a><a name="en-us_topic_0076901182_li21151286"></a>Expanding the capacity of a shared file system to 2 GB:<pre class="screen" id="sfs_02_0034__se4447b9628bd41c9bfa67c3a8dfe3238">{
     "os-extend": {
         "new_size": 2
     }
 }</pre>
+</div>
 </li></ul>
 </div>
 <div class="section" id="sfs_02_0034__s8703d904c5b7413188ce12352326a73e"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0034__en-us_topic_0076901182_ul51358334"><li id="sfs_02_0034__en-us_topic_0076901182_li59571824">Parameter description<p id="sfs_02_0034__af40a8a72fa024e808a84943a44c493cf"><a name="sfs_02_0034__en-us_topic_0076901182_li59571824"></a><a name="en-us_topic_0076901182_li59571824"></a>None</p>

docs/sfs/api-ref/sfs_02_0035.html

@@ -86,11 +86,12 @@
 </table>
 </div>
 </li></ul>
-<ul id="sfs_02_0035__en-us_topic_0076901183_ul27711559"><li id="sfs_02_0035__en-us_topic_0076901183_li48077445">Example request<pre class="screen" id="sfs_02_0035__sac0c010b0819470dbf835bb6978f07b7">{
+<ul id="sfs_02_0035__en-us_topic_0076901183_ul27711559"><li id="sfs_02_0035__en-us_topic_0076901183_li48077445">Example request<div class="p" id="sfs_02_0035__p10104111575918"><a name="sfs_02_0035__en-us_topic_0076901183_li48077445"></a><a name="en-us_topic_0076901183_li48077445"></a>Reducing the capacity of a shared file system to 1 GB:<pre class="screen" id="sfs_02_0035__sac0c010b0819470dbf835bb6978f07b7">{
     "os-shrink": {
         "new_size": 1
     }
 }</pre>
+</div>
 </li></ul>
 </div>
 <div class="section" id="sfs_02_0035__sc7abb610536242c4b1c4b3c9bc3a698b"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0035__en-us_topic_0076901183_ul17630956"><li id="sfs_02_0035__en-us_topic_0076901183_li24460881">Parameter description<p id="sfs_02_0035__ac8e994a8649342a0955694a3b7cecbc9"><a name="sfs_02_0035__en-us_topic_0076901183_li24460881"></a><a name="en-us_topic_0076901183_li24460881"></a>None</p>

docs/sfs/api-ref/sfs_02_0049.html

@@ -4,17 +4,17 @@
 <div id="body1540364281867"></div>
 <div>
 <ul class="ullinks">
-<li class="ulchildlink"><strong><a href="sfs_02_0050.html">Lifecycle Management</a></strong><br>
+<li class="ulchildlink"><strong><a href="topic_300000000.html">Lifecycle Management</a></strong><br>
 </li>
-<li class="ulchildlink"><strong><a href="sfs_02_0055.html">Storage Capacity Management</a></strong><br>
+<li class="ulchildlink"><strong><a href="topic_300000001.html">Connection Management</a></strong><br>
 </li>
-<li class="ulchildlink"><strong><a href="sfs_02_0096.html">Connection Management</a></strong><br>
+<li class="ulchildlink"><strong><a href="topic_300000002.html">Tag Management</a></strong><br>
 </li>
-<li class="ulchildlink"><strong><a href="sfs_02_0074.html">Tag Management</a></strong><br>
+<li class="ulchildlink"><strong><a href="topic_300000003.html">Name Management</a></strong><br>
 </li>
-<li class="ulchildlink"><strong><a href="en-us_topic_0000001537230113.html">Name Management</a></strong><br>
+<li class="ulchildlink"><strong><a href="topic_300000007.html">Permissions Management</a></strong><br>
 </li>
-<li class="ulchildlink"><strong><a href="en-us_topic_0000001663116961.html">Permissions Management</a></strong><br>
+<li class="ulchildlink"><strong><a href="topic_300000008.html">Task Management</a></strong><br>
 </li>
 </ul>
 </div>

docs/sfs/api-ref/sfs_02_0050.html

@@ -1,21 +0,0 @@
-<a name="sfs_02_0050"></a><a name="sfs_02_0050"></a>
-
-<h1 class="topictitle1">Lifecycle Management</h1>
-<div id="body1540364633034"></div>
-<div>
-<ul class="ullinks">
-<li class="ulchildlink"><strong><a href="sfs_02_0051.html">Creating a File System</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="sfs_02_0052.html">Deleting a File System</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="sfs_02_0053.html">Querying Details About All File Systems</a></strong><br>
-</li>
-<li class="ulchildlink"><strong><a href="sfs_02_0054.html">Querying Details About a Single File System</a></strong><br>
-</li>
-</ul>
-
-<div class="familylinks">
-<div class="parentlink"><strong>Parent topic:</strong> <a href="sfs_02_0049.html">SFS Turbo APIs</a></div>
-</div>
-</div>
-