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

sfs_api_251009

Browse Source 
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: lizaoxu <lizaoxu@huawei.com>
Co-committed-by: lizaoxu <lizaoxu@huawei.com>
This commit is contained in:
Zaoxu, Li
2025-12-03 13:51:09 +00:00
committed by zuul
parent c7ca14ad93
commit 3bac3b88e8
46 changed files with 4609 additions and 1418 deletions
Download Patch File Download Diff File Expand all files Collapse all files

348
docs/sfs/api-ref/ALL_META.TXT.json
View File

File diff suppressed because it is too large Load Diff

42
docs/sfs/api-ref/BatchAddSharedTags.html
View File

File diff suppressed because it is too large Load Diff

268
docs/sfs/api-ref/CLASS.TXT.json
View File

File diff suppressed because it is too large Load Diff

22
docs/sfs/api-ref/ChangeSecurityGroup.html
View File

@ -1,7 +1,7 @@
<a name="ChangeSecurityGroup"></a><a name="ChangeSecurityGroup"></a>
<h1 class="topictitle1">Changing the Security Group Associated with a File System</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to change the security group associated with an SFS Turbo file system. Security group change is an asynchronous task. You can check whether the security group is changed based on the value of <strong>sub_status</strong> returned after calling the API to query details of a file system. If value <strong>232</strong> is returned, the security group has been changed.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to change the security group associated with an SFS Turbo file system. Changing the security group is an asynchronous task. You can call the API for querying details of a file system and view the value of <strong>sub_status</strong> returned to check whether the security group change is successful. If value <strong>232</strong> is returned, the security group has been changed.</p>
</div>
<div class="section" id="ChangeSecurityGroup__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v1/{project_id}/sfs-turbo/shares/{share_id}/action</p>
@ -21,7 +21,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The project ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>share_id</p>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>File system ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The file system ID.</p>
</td>
</tr>
</tbody>
@ -54,7 +54,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Account token</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The account token.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
@ -63,7 +63,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>MIME type</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The MIME type.</p>
</td>
</tr>
</tbody>
@ -86,7 +86,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p><a href="#ChangeSecurityGroup__request_ChangeSecurityGroup">ChangeSecurityGroup</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Object of <strong>change_security_group</strong></p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>The <strong>change_security_group</strong> object.</p>
</td>
</tr>
</tbody>
@ -109,7 +109,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>ID of the security group to be changed</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>The ID of the new security group.</p>
</td>
</tr>
</tbody>
@ -130,14 +130,14 @@
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>ID of the SFS Turbo file system</p>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>The SFS Turbo file system ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Changing the security group of a file system (target security group ID <strong>26f6b565-240e-43c3-8867-03f0bd975433</strong>)</p>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Changing the security group of a file system (new security group ID <strong>26f6b565-240e-43c3-8867-03f0bd975433</strong>)</p>
<pre class="screen">{
"change_security_group" : {
"security_group_id" : "26f6b565-240e-43c3-8867-03f0bd975433"
@ -145,7 +145,7 @@
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 202</strong></p>
<p>ID of the SFS Turbo file system</p>
<p>The SFS Turbo file system ID.</p>
<pre class="screen">{
"id" : "67d4bd5e-7b2f-4c24-9a0b-c0038940c6f8"
}</pre>
@ -159,7 +159,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>202</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>ID of the SFS Turbo file system</p>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>The SFS Turbo file system ID.</p>
</td>
</tr>
</tbody>

24
docs/sfs/api-ref/ChangeShareName.html
View File

@ -1,7 +1,7 @@
<a name="ChangeShareName"></a><a name="ChangeShareName"></a>
<h1 class="topictitle1">Changing the Name of a File System</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to change the name of an SFS Turbo file system.</p>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to change the name of a file system.</p>
</div>
<div class="section" id="ChangeShareName__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v1/{project_id}/sfs-turbo/shares/{share_id}/action</p>
@ -21,7 +21,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The project ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>share_id</p>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>File system ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The file system ID.</p>
</td>
</tr>
</tbody>
@ -54,7 +54,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Account token</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The account token.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
@ -63,7 +63,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>MIME type</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The MIME type.</p>
</td>
</tr>
</tbody>
@ -86,7 +86,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p><a href="#ChangeShareName__request_ShareName">ShareName</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>SFS Turbo file system to be modified</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>The file system to be modified.</p>
</td>
</tr>
</tbody>
@ -109,14 +109,16 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Name of the SFS Turbo file system to be modified</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>The name of the file system to be modified.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p>None</p>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 204</strong></p>
<p>Successful request</p>
<p>None</p>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Changing the name of an SFS Turbo file system to <strong>sfs-turbo-test1</strong></p>
<pre class="screen">{
@ -136,17 +138,17 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Request successful</p>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Successful request</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Invalid parameter</p>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Incorrect parameter</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>The file system name already exists.</p>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>File system name already exists</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>500</p>

61
docs/sfs/api-ref/CreatePermRule.html
View File

File diff suppressed because it is too large Load Diff

318
docs/sfs/api-ref/CreateShare.html
View File

File diff suppressed because it is too large Load Diff

24
docs/sfs/api-ref/CreateSharedTag.html
View File

@ -1,7 +1,7 @@
<a name="CreateSharedTag"></a><a name="CreateSharedTag"></a>
<h1 class="topictitle1">Adding a Tag for a File System</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to add a tag to a specified file system.</p>
<h1 class="topictitle1">Adding a Tag to a File System</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to add a tag to a file system.</p>
<p>A maximum of 20 tags can be added to a file system.</p>
<p>Tag keys added to the same file system must be unique.</p>
<p>This API is idempotent. If the file system already has the key you want to add, the tag will be updated.</p>
@ -24,7 +24,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The project ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>share_id</p>
@ -33,7 +33,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>File system ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The file system ID.</p>
</td>
</tr>
</tbody>
@ -57,7 +57,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Account token</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The account token.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
@ -66,7 +66,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>MIME type</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The MIME type.</p>
</td>
</tr>
</tbody>
@ -89,7 +89,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p><a href="#CreateSharedTag__request_ResourceTag">ResourceTag</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Description of the <strong>resource_tag</strong> field</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>The <strong>resource_tag</strong> field description.</p>
</td>
</tr>
</tbody>
@ -112,7 +112,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Tag key.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>The tag key.</p>
<p>It can contain a maximum of 128 characters.</p>
<p>It cannot be left empty and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (&lt;), right angle brackets (&gt;), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
@ -123,7 +123,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>Tag value.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p>The tag value.</p>
<p>Each tag value can contain a maximum of 255 characters and can be an empty string.</p>
<p>It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (&lt;), right angle brackets (&gt;), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
@ -132,7 +132,9 @@
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p>None</p>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 204</strong></p>
<p>Tag adding request delivered</p>
<p>None</p>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Creating a file system tag, with tag value set to <strong>key1</strong> and tag key <strong>value1</strong></p>
<pre class="screen">{
@ -153,7 +155,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Tag adding request delivered.</p>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Tag adding request delivered</p>
</td>
</tr>
</tbody>

116
docs/sfs/api-ref/DeletePermRule.html
View File

File diff suppressed because it is too large Load Diff

14
docs/sfs/api-ref/DeleteShare.html
View File

@ -21,7 +21,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The project ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>share_id</p>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>File system ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The file system ID.</p>
</td>
</tr>
</tbody>
@ -54,7 +54,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Account token</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The account token.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
@ -63,14 +63,16 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>MIME type</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The MIME type.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p>None</p>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 202</strong></p>
<p>File system deletion request delivered</p>
<p>None</p>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Deleting the file system whose ID is <strong>77ba6f4b-6365-4895-8dda-bc7142af4dde</strong></p>
<pre class="screen">DELETE HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde</pre>
@ -86,7 +88,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>202</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>File system deletion request delivered.</p>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>File system deletion request delivered</p>
</td>
</tr>
</tbody>

24
docs/sfs/api-ref/DeleteSharedTag.html
View File

@ -1,7 +1,7 @@
<a name="DeleteSharedTag"></a><a name="DeleteSharedTag"></a>
<h1 class="topictitle1">Deleting a Tag of a File System</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a tag of a specified file system. If the key to be deleted does not exist, error 404 will be returned.</p>
<h1 class="topictitle1">Deleting a Tag from a File System</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a tag from a file system. If the specified key is not found, error 404 will be returned.</p>
</div>
<div class="section" id="DeleteSharedTag__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/sfs-turbo/{share_id}/tags/{key}</p>
@ -21,7 +21,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The project ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>share_id</p>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>File system ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The file system ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>key</p>
@ -39,8 +39,8 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Tag key, which can contain a maximum of 128 characters.</p>
<p>It cannot be left blank and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (&lt;), right angle brackets (&gt;), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The tag key, which can contain a maximum of 128 characters.</p>
<p>It cannot be left empty and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (&lt;), right angle brackets (&gt;), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).</p>
<p>When this API is called to delete a tag, if the tag key contains special characters that cannot be directly resolved by the URL, the key needs to be escaped.</p>
</td>
</tr>
@ -65,7 +65,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Account token</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The account token.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
@ -74,16 +74,18 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>MIME type</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The MIME type.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p>None</p>
<div class="section"><h4 class="sectiontitle">Response Parameters</h4><p><strong>Status code: 204</strong></p>
<p>Tag deleted</p>
<p>None</p>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Deleting tags whose key is <strong>test</strong> for the file system whose ID is <strong>77ba6f4b-6365-4895-8dda-bc7142af4dde</strong></p>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Deleting a tag (tag key is <strong>test</strong>) from the file system whose ID is <strong>77ba6f4b-6365-4895-8dda-bc7142af4dde</strong></p>
<pre class="screen">DELETE HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/77ba6f4b-6365-4895-8dda-bc7142af4dde/tags/test</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p>None</p>
@ -97,7 +99,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>File system tag deleted.</p>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Tag deleted</p>
</td>
</tr>
</tbody>

142
docs/sfs/api-ref/ExpandShare.html
View File

File diff suppressed because it is too large Load Diff

157
docs/sfs/api-ref/ListPermRules.html
View File

File diff suppressed because it is too large Load Diff

22
docs/sfs/api-ref/ListSharedTags.html
View File

@ -21,7 +21,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The project ID.</p>
</td>
</tr>
</tbody>
@ -44,7 +44,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Number of returned tags</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>The maximum number of tags that can be returned.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>offset</p>
@ -53,7 +53,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Tag query offset</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>The tag query offset.</p>
</td>
</tr>
</tbody>
@ -77,7 +77,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Account token</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The account token.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
@ -86,7 +86,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>MIME type</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The MIME type.</p>
</td>
</tr>
</tbody>
@ -107,7 +107,7 @@
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ListSharedTags__response_Tag">Tag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>Tag list</p>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>The tag list.</p>
</td>
</tr>
</tbody>
@ -126,7 +126,7 @@
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag key.</p>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>The tag key.</p>
<p>A key can contain a maximum of 128 characters and cannot be left blank.</p>
</td>
</tr>
@ -134,18 +134,18 @@
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag values. Each value can contain a maximum of 255 characters. An empty list of values can match with any value. All values of a tag key are in the OR relationship.</p>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>The list the tag values. Each value can contain a maximum of 255 characters. An empty list for <strong>values</strong> indicates any value. The values are in the OR relationship.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Query tags of all file systems in the project whose ID is <strong>e1e45b08f3ea4480ab4655ef9c7160ba</strong></p>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><p>Querying tags of all file systems in the project whose ID is <strong>e1e45b08f3ea4480ab4655ef9c7160ba</strong></p>
<pre class="screen">GET HTTPS://{endpoint}/v1/e1e45b08f3ea4480ab4655ef9c7160ba/sfs-turbo/tags</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>Response body for querying a file system</p>
<p>Query response body</p>
<pre class="screen">{
"tags" : [ {
"key" : "key1",
@ -165,7 +165,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p>200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Response body for querying a file system</p>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p>Query response body</p>
</td>
</tr>
</tbody>

583
docs/sfs/api-ref/ListShares.html
View File

File diff suppressed because it is too large Load Diff

484
docs/sfs/api-ref/ListSharesByTag.html Normal file
View File

File diff suppressed because it is too large Load Diff

307
docs/sfs/api-ref/ShowClientIpInfo.html Normal file
View File

File diff suppressed because it is too large Load Diff

179
docs/sfs/api-ref/ShowJobDetail.html
View File

File diff suppressed because it is too large Load Diff

192
docs/sfs/api-ref/ShowPermRule.html
View File

File diff suppressed because it is too large Load Diff

324
docs/sfs/api-ref/ShowQuota.html Normal file
View File

File diff suppressed because it is too large Load Diff

519
docs/sfs/api-ref/ShowShare.html
View File

File diff suppressed because it is too large Load Diff

29
docs/sfs/api-ref/ShowSharedTags.html
View File

@ -1,7 +1,7 @@
<a name="ShowSharedTags"></a><a name="ShowSharedTags"></a>
<h1 class="topictitle1">Querying Tags of a File System</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query all tags of a specified file system.</p>
<h1 class="topictitle1">Querying All Tags of a File System</h1>
<div id="body1708331107508"><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query all tags of a file system.</p>
</div>
<div class="section" id="ShowSharedTags__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/sfs-turbo/{share_id}/tags</p>
@ -21,7 +21,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The project ID.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>share_id</p>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>File system ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>The file system ID.</p>
</td>
</tr>
</tbody>
@ -54,7 +54,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>Account token</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The account token.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
@ -63,7 +63,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>MIME type</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p>The MIME type.</p>
</td>
</tr>
</tbody>
@ -84,18 +84,7 @@
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ShowSharedTags__response_ResourceTag">ResourceTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>Tag list</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p>sys_tags</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of <a href="#ShowSharedTags__response_ResourceTag">ResourceTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>Only users with the op_service permission can obtain this field.</p>
<ol><li><p>This field currently contains only one resource_tag structure key, <strong>_sys_enterprise_project_id</strong>.</p>
</li><li><p>The key contains only value <strong>0</strong> currently, which indicates the default enterprise project.</p>
</li></ol>
<p>This field is not returned for users without the op_service permission.</p>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p>The tag list.</p>
</td>
</tr>
</tbody>
@ -114,7 +103,7 @@
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag key.</p>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>The tag key.</p>
<p>It can contain a maximum of 128 characters.</p>
<p>It cannot be left empty and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (&lt;), right angle brackets (&gt;), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
@ -123,7 +112,7 @@
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>Tag value.</p>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p>The tag value.</p>
<p>Each tag value can contain a maximum of 255 characters and can be an empty string.</p>
<p>It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (&lt;), right angle brackets (&gt;), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>

259
docs/sfs/api-ref/UpdatePermRule.html
View File

File diff suppressed because it is too large Load Diff

8
docs/sfs/api-ref/sfs_02_0009.html
View File

@ -80,7 +80,7 @@
</table>
</div>
</div>
<p id="sfs_02_0009__en-us_topic_0121682347_p3759142614815">For example, in the case of the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request method is <span class="parmname" id="sfs_02_0009__en-us_topic_0121682347_parmname369469101"><b>POST</b></span>. The request is as follows:</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p3759142614815">For example, in the case of the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request method is <span class="parmname" id="sfs_02_0009__en-us_topic_0121682347_parmname1652714276561"><b>POST</b></span>. The request is as follows:</p>
<div class="codecoloring" codetype="Java" id="sfs_02_0009__en-us_topic_0121682347_screen7888377244"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</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/tokens</span>
</pre></div></td></tr></table></div>
</div>
@ -156,7 +156,7 @@
<div class="note" id="sfs_02_0009__en-us_topic_0121682347_note13771123325011"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0009__en-us_topic_0121682347_p1513412221808">In addition to supporting authentication using tokens, APIs support authentication using AK/SK, which uses SDKs to sign a request. During the signature, the <strong id="sfs_02_0009__en-us_topic_0121682347_b1411717123020">Authorization</strong> (signature authentication) and <strong id="sfs_02_0009__en-us_topic_0121682347_b91187122001">X-Sdk-Date</strong> (time when a request is sent) headers are automatically added in the request.</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p1577123365010">For more details, see "Authentication Using AK/SK" in <a href="sfs_02_0011.html">Authentication</a>.</p>
</div></div>
<p id="sfs_02_0009__en-us_topic_0121682347_p9786614164616">The API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a> does not require authentication. Therefore, only the <strong id="sfs_02_0009__en-us_topic_0121682347_b4395911286">Content-Type</strong> field needs to be added to requests for calling the API. An example of such requests is as follows:</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p9786614164616">The API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a> does not require authentication. Therefore, only the <strong id="sfs_02_0009__en-us_topic_0121682347_b201361848185812">Content-Type</strong> field needs to be added to requests for calling the API. An example of such requests is as follows:</p>
<div class="codecoloring" codetype="Java" id="sfs_02_0009__en-us_topic_0121682347_screen73731462616"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</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/tokens</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>
@ -165,7 +165,7 @@
</div>
<div class="section" id="sfs_02_0009__en-us_topic_0121682347_en-us_topic_0113746487_section1437471411"><h4 class="sectiontitle">(Optional) Request Body</h4><p id="sfs_02_0009__en-us_topic_0121682347_en-us_topic_0113746487_p76011911717">This part is optional. The body of a request is often sent in a structured format (for example, JSON or XML) as specified in the <strong id="sfs_02_0009__en-us_topic_0121682347_b190810592581">Content-Type</strong> header field. The request body transfers content except the request header.</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p1847214711331">The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p105261225101112">In the case of the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace <em id="sfs_02_0009__en-us_topic_0121682347_i1572635433110">username</em>, <em id="sfs_02_0009__en-us_topic_0121682347_i47260544318">domainname</em>, <em id="sfs_02_0009__en-us_topic_0121682347_i4726155493118">$ADMIN_PASS</em> (login password), and <em id="sfs_02_0009__en-us_topic_0121682347_i1072613546317">xxxxxxxxxxxxxxxxxx</em> (project name) with the actual values. Obtain a project name from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p105261225101112">In the case of the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace <em id="sfs_02_0009__en-us_topic_0121682347_i173931259123513">username</em>, <em id="sfs_02_0009__en-us_topic_0121682347_i15393155993513">domainname</em>, <em id="sfs_02_0009__en-us_topic_0121682347_i20393559113515">$ADMIN_PASS</em> (login password), and <em id="sfs_02_0009__en-us_topic_0121682347_i14393205933515">xxxxxxxxxxxxxxxxxx</em> (project name) with the actual values. Obtain a project name from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
<div class="note" id="sfs_02_0009__en-us_topic_0121682347_note15403511418"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0009__en-us_topic_0121682347_p199011223194814">The <strong id="sfs_02_0009__en-us_topic_0121682347_b1186815753415">scope</strong> parameter specifies where a token takes effect. You can set <strong id="sfs_02_0009__en-us_topic_0121682347_b1246371618347">scope</strong> to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">Obtaining a User Token</a>.</p>
</div></div>
<div class="codecoloring" codetype="Java" id="sfs_02_0009__en-us_topic_0121682347_screen6140617194816"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
@ -221,7 +221,7 @@
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
<p id="sfs_02_0009__en-us_topic_0121682347_p1859663401915">If all data required for the API request is available, you can send the request to call the API through <a href="https://curl.haxx.se/" target="_blank" rel="noopener noreferrer">curl</a>, <a href="https://www.getpostman.com/" target="_blank" rel="noopener noreferrer">Postman</a>, or coding. In the response to the API used to obtain a user token, <strong id="sfs_02_0009__en-us_topic_0121682347_b349349294">X-Subject-Token</strong> is the desired user token. This token can then be used to authenticate the calling of other APIs.</p>
<p id="sfs_02_0009__en-us_topic_0121682347_p1859663401915">If all data required for the API request is available, you can send the request to call the API through <a href="https://curl.haxx.se/" target="_blank" rel="noopener noreferrer">curl</a>, <a href="https://www.getpostman.com/" target="_blank" rel="noopener noreferrer">Postman</a>, or coding. In the response to the API used to obtain a user token, <strong id="sfs_02_0009__en-us_topic_0121682347_b822194612218">X-Subject-Token</strong> is the desired user token. This token can then be used to authenticate the calling of other APIs.</p>
</div>
</div>
<div>

14
docs/sfs/api-ref/sfs_02_0011.html
View File

@ -3,15 +3,15 @@
<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 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"><ul id="sfs_02_0011__en-us_topic_0121671869_ul1391194815339"><li id="sfs_02_0011__en-us_topic_0121671869_li591174818336">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.</li><li id="sfs_02_0011__en-us_topic_0121671869_li1492910572112">API Gateway checks the time format and compares the request time with the time when API Gateway received the request. If the time difference exceeds 15 minutes, API Gateway will reject the request. So, the local time on the client must be synchronized with the clock server to avoid a large offset in the value of <strong id="sfs_02_0011__en-us_topic_0121671869_b201061251503">X-Sdk-Date</strong> in the request header.</li></ul>
</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>
<p id="sfs_02_0011__en-us_topic_0121671869_p171211559122516">In AK/SK authentication, an AK/SK pair 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>
<p id="sfs_02_0011__en-us_topic_0121671869_p1866949103516">In AK/SK authentication, you can use an AK/SK pair 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 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"><ul id="sfs_02_0011__en-us_topic_0121671869_ul767015291815"><li id="sfs_02_0011__en-us_topic_0121671869_li192544361384">A token remains valid for 24 hours after it is generated. You can cache a token and reuse it for authentication instead of generating a new one each time.</li><li id="sfs_02_0011__en-us_topic_0121671869_li368213291286">Before using a token, ensure that it has sufficient time remaining before expiration. Using a near-expiry token may cause API call failures.</li></ul>
</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 a 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>
@ -24,10 +24,10 @@
],
"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.
"name": "<em id="sfs_02_0011__en-us_topic_0121671869_i1520313410406"><strong id="sfs_02_0011__en-us_topic_0121671869_b1320394204020">username</strong></em>", // IAM user name
"password": <em id="sfs_02_0011__en-us_topic_0121671869_i133611321164017"><strong id="sfs_02_0011__en-us_topic_0121671869_b1361132134013">$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 that the IAM user belongs to
"name": "<em id="sfs_02_0011__en-us_topic_0121671869_i18683128184117"><strong id="sfs_02_0011__en-us_topic_0121671869_b1368315818412">domainname</strong></em>" // Name of the domain that the IAM user belongs to
}
}
}

4
docs/sfs/api-ref/sfs_02_0012.html
View File

@ -3,10 +3,10 @@
<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_parmvalue9688294226"><b>201</b></span> is returned for calling the API used to , the request is successful.</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_parmvalue6943927133219"><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_b154611792511">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>
<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 for the API used to . The <strong id="sfs_02_0012__en-us_topic_0170155703_b109193191446">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>

2
docs/sfs/api-ref/sfs_02_0014.html
View File

@ -41,7 +41,7 @@
"is_public": false
}
}</pre>
<ul id="sfs_02_0014__ul281147101818"><li id="sfs_02_0014__li10828476187"><strong id="sfs_02_0014__b135459819104">#sfs_crypt_key_id</strong>: Specifies the encryption key ID. If <strong id="sfs_02_0014__b39866814912">#sfs_crypt_key_id</strong>, <strong id="sfs_02_0014__b842352706102249">#sfs_crypt_domain_id</strong>, and <strong id="sfs_02_0014__b842352706102259">#sfs_crypt_alias</strong> exist at the same time, the data encryption function is enabled.</li><li id="sfs_02_0014__li116161011887"><strong id="sfs_02_0014__b121083287124">#sfs_crypt_domain_id</strong>: Specifies the tenant domain ID. If <strong id="sfs_02_0014__b2978194911">#sfs_crypt_domain_id</strong>, <strong id="sfs_02_0014__b153977858">#sfs_crypt_key_id</strong>, and <strong id="sfs_02_0014__b1974381955">#sfs_crypt_alias</strong> exist at the same time, the data encryption function is enabled.</li><li id="sfs_02_0014__li184110121816"><strong id="sfs_02_0014__b1589119542136">#sfs_crypt_alias</strong>: Specifies the encryption key alias. If <strong id="sfs_02_0014__b1913312304919">#sfs_crypt_alias</strong>, <strong id="sfs_02_0014__b1095148401">#sfs_crypt_key_id</strong>, and <strong id="sfs_02_0014__b1422762190">#sfs_crypt_domain_id</strong> exist at the same time, the data encryption function is enabled.</li></ul>
<ul id="sfs_02_0014__ul281147101818"><li id="sfs_02_0014__li10828476187"><strong id="sfs_02_0014__b135459819104">#sfs_crypt_key_id</strong>: Specifies the encryption key ID. If <strong id="sfs_02_0014__b39866814912">#sfs_crypt_key_id</strong>, <strong id="sfs_02_0014__b842352706102249">#sfs_crypt_domain_id</strong>, and <strong id="sfs_02_0014__b842352706102259">#sfs_crypt_alias</strong> exist at the same time, the data encryption function is enabled.</li><li id="sfs_02_0014__li116161011887"><strong id="sfs_02_0014__b121083287124">#sfs_crypt_domain_id</strong>: Specifies the tenant domain ID. If <strong id="sfs_02_0014__b2978194911">#sfs_crypt_domain_id</strong>, <strong id="sfs_02_0014__b1042501305">#sfs_crypt_key_id</strong>, and <strong id="sfs_02_0014__b1194457898">#sfs_crypt_alias</strong> exist at the same time, the data encryption function is enabled.</li><li id="sfs_02_0014__li184110121816"><strong id="sfs_02_0014__b1589119542136">#sfs_crypt_alias</strong>: Specifies the encryption key alias. If <strong id="sfs_02_0014__b1913312304919">#sfs_crypt_alias</strong>, <strong id="sfs_02_0014__b1951830176">#sfs_crypt_key_id</strong>, and <strong id="sfs_02_0014__b498430989">#sfs_crypt_domain_id</strong> exist at the same time, the data encryption function is enabled.</li></ul>
</div>
</div>

2
docs/sfs/api-ref/sfs_02_0015.html
View File

@ -5,7 +5,7 @@
<div class="note" id="sfs_02_0015__note954974119286"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0015__p954984111284">The token obtained from IAM is valid for only 24 hours. If you want to use one token for authentication, you can cache it to avoid frequently calling.</p>
</div></div>
<div class="section" id="sfs_02_0015__section17616103371"><h4 class="sectiontitle">Involved APIs</h4><p id="sfs_02_0015__p7881209153012">If you use a token for authentication, you must obtain the token and add <strong id="sfs_02_0015__a30f5ab3fed6442ae8652ac00a2dffc7e">X-Auth-Token</strong> to the request header of the API when making a call. The following APIs are involved in the request for creating an SFS Turbo file system:</p>
<ul id="sfs_02_0015__ul1688118911309"><li id="sfs_02_0015__li10881139103017">API for obtaining tokens from IAM</li><li id="sfs_02_0015__li788118903015">API for creating SFS Turbo file systems.</li></ul>
<ul id="sfs_02_0015__ul1688118911309"><li id="sfs_02_0015__li10881139103017">IAM API used to obtain a token</li><li id="sfs_02_0015__li788118903015">API for creating SFS Turbo file systems.</li></ul>
</div>
<div class="section" id="sfs_02_0015__section8823194612355"><h4 class="sectiontitle">Procedure</h4><ol id="sfs_02_0015__ol12128172414430"><li id="sfs_02_0015__li1712852410430"><span>Obtain the token by following instructions in <a href="sfs_02_0011.html">Authentication</a>.</span></li><li id="sfs_02_0015__li1012810247438"><span>Add <strong id="sfs_02_0015__b9793185310511">X-Auth-Token</strong> to the request header.</span></li><li id="sfs_02_0015__li11128152413438"><span>Specify the following parameters in the request body:</span><p><pre class="screen" id="sfs_02_0015__screen12128132410438">{
"share": {

4
docs/sfs/api-ref/sfs_02_0049.html
View File

@ -12,10 +12,14 @@
</li>
<li class="ulchildlink"><strong><a href="topic_300000003.html">Name Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000004.html">File System Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000007.html">Permissions Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000008.html">Task Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000011.html">Tenant Quota Management</a></strong><br>
</li>
</ul>
</div>

2
docs/sfs/api-ref/sfs_02_0080.html
View File

@ -4,7 +4,7 @@
<div id="body1559728724721"><p id="sfs_02_0080__p1773914613588">This section describes fine-grained permissions management for your SFS resources. If your cloud account does not need individual IAM users, then you may skip over this section.</p>
<p id="sfs_02_0080__p373917464584">By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.</p>
<p id="sfs_02_0080__p1673974695813">You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.</p>
<div class="note" id="sfs_02_0080__note12194154412428"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="sfs_02_0080__ul754160195919"><li id="sfs_02_0080__li1454615141918">Policy-based authorization is useful if you want to allow or deny the access to an API.</li></ul>
<div class="note" id="sfs_02_0080__note12194154412428"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0080__p12572232548">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
</div></div>
<p id="sfs_02_0080__p72721744174218">Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query ECSs using an API, the user must have been granted permissions that allow the <strong id="sfs_02_0080__b983516555436">ecs:servers:list</strong> action.</p>
<div class="section" id="sfs_02_0080__section54925131575"><h4 class="sectiontitle">Supported Actions</h4><p id="sfs_02_0080__p1024315617012">SFS provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:</p>

41
docs/sfs/api-ref/sfs_02_0083.html
View File

@ -21,8 +21,8 @@
</td>
<td class="cellrowborder" valign="top" width="22.323951622018768%" headers="mcps1.3.1.2.1.6.1.3 "><p id="sfs_02_0083__p145981424577">sfsturbo:shares:createShare</p>
</td>
<td class="cellrowborder" valign="top" width="25.816661015033343%" headers="mcps1.3.1.2.1.6.1.4 "><ul id="sfs_02_0083__ul19598174235712"><li id="sfs_02_0083__li059864275716">You must have VPC-related permissions when creating an SFS Turbo instance, including the permissions for verifying VPCs, subnets, and security groups, creating virtual IP addresses and ports, and creating security group rules. You must add the following action:<ul id="sfs_02_0083__ul13598174275712"><li id="sfs_02_0083__li2059864245718">"vpc:*:*"</li></ul>
</li><li id="sfs_02_0083__li85989426572">The KMS Administrator permission needs to be configured for the encrypted instance in the project.</li></ul>
<td class="cellrowborder" valign="top" width="25.816661015033343%" headers="mcps1.3.1.2.1.6.1.4 "><ul id="sfs_02_0083__ul19598174235712"><li id="sfs_02_0083__li059864275716">Creating an SFS Turbo file system requires VPC-related permissions, including the permissions for verifying VPCs, subnets, and security groups, creating virtual IP addresses and ports, and creating security group rules.<ul id="sfs_02_0083__ul13598174275712"><li id="sfs_02_0083__li2059864245718">"vpc:*:*"</li></ul>
</li><li id="sfs_02_0083__li85989426572">Creating an encrypted SFS Turbo file system requires the KMS Administrator permissions.</li></ul>
</td>
<td class="cellrowborder" valign="top" width="11.947552842771563%" headers="mcps1.3.1.2.1.6.1.5 "><p id="sfs_02_0083__p1059824218574">√</p>
</td>
@ -44,7 +44,7 @@
</td>
<td class="cellrowborder" valign="top" width="22.323951622018768%" headers="mcps1.3.1.2.1.6.1.3 "><p id="sfs_02_0083__p16598104295718">sfsturbo:shares:deleteShare</p>
</td>
<td class="cellrowborder" valign="top" width="25.816661015033343%" headers="mcps1.3.1.2.1.6.1.4 "><ul id="sfs_02_0083__ul159874205712"><li id="sfs_02_0083__li6598442175719">To delete an SFS Turbo instance, you must have VPC-related permissions, including the permissions for deleting virtual IP addresses, ports, and security group rules. You must add the following action:<ul id="sfs_02_0083__ul7598164218571"><li id="sfs_02_0083__li17598842115713">"vpc:*:*"</li></ul>
<td class="cellrowborder" valign="top" width="25.816661015033343%" headers="mcps1.3.1.2.1.6.1.4 "><ul id="sfs_02_0083__ul159874205712"><li id="sfs_02_0083__li6598442175719">Deleting an SFS Turbo file system requires VPC-related permissions, including the permissions for deleting virtual IP addresses and ports and deleting security group rules.<ul id="sfs_02_0083__ul7598164218571"><li id="sfs_02_0083__li17598842115713">"vpc:*:*"</li></ul>
</li></ul>
</td>
<td class="cellrowborder" valign="top" width="11.947552842771563%" headers="mcps1.3.1.2.1.6.1.5 "><p id="sfs_02_0083__p20599134210577">√</p>
@ -96,7 +96,7 @@
</td>
<td class="cellrowborder" valign="top" width="22.472295213069806%" headers="mcps1.3.2.2.1.6.1.3 "><p id="sfs_02_0083__p146799345112">sfsturbo:shares:shareAction</p>
</td>
<td class="cellrowborder" valign="top" width="24.43733577059294%" headers="mcps1.3.2.2.1.6.1.4 "><p id="sfs_02_0083__p179559592148">To modify a security group, you must have the following permissions:</p>
<td class="cellrowborder" valign="top" width="24.43733577059294%" headers="mcps1.3.2.2.1.6.1.4 "><p id="sfs_02_0083__p179559592148">Changing a security group requires the following permissions:</p>
<ul id="sfs_02_0083__ul144155112392"><li id="sfs_02_0083__li1444195143915">vpc:securityGroups:*</li><li id="sfs_02_0083__li144411519393">vpc:securityGroupRules:*</li></ul>
</td>
<td class="cellrowborder" valign="top" width="12.292928138923799%" headers="mcps1.3.2.2.1.6.1.5 "><p id="sfs_02_0083__p24267342598">√</p>
@ -244,7 +244,7 @@
<td class="cellrowborder" valign="top" width="11.947552842771563%" headers="mcps1.3.5.2.1.6.1.5 "><p id="sfs_02_0083__p123981831300">√</p>
</td>
</tr>
<tr id="sfs_02_0083__row199115454153"><td class="cellrowborder" valign="top" width="17.92698089747937%" headers="mcps1.3.5.2.1.6.1.1 "><p id="sfs_02_0083__p1957981121716">Querying Permissions Rules of a File System</p>
<tr id="sfs_02_0083__row199115454153"><td class="cellrowborder" valign="top" width="17.92698089747937%" headers="mcps1.3.5.2.1.6.1.1 "><p id="sfs_02_0083__p1957981121716">Querying Permission Rules of a File System</p>
</td>
<td class="cellrowborder" valign="top" width="21.984853622696964%" headers="mcps1.3.5.2.1.6.1.2 "><p id="sfs_02_0083__p1157913112171">GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules</p>
</td>
@ -321,7 +321,7 @@
</table>
</div>
</div>
<div class="section" id="sfs_02_0083__section6221921163313"><h4 class="sectiontitle">APIs for Console Only</h4>
<div class="section" id="sfs_02_0083__section6221921163313"><h4 class="sectiontitle">Console Reference</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0083__table107154723316" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0083__row1981475338"><th align="left" class="cellrowborder" valign="top" width="20.238504758628597%" id="mcps1.3.7.2.1.6.1.1"><p id="sfs_02_0083__p1618412118339">Permission</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.046554294232314%" id="mcps1.3.7.2.1.6.1.2"><p id="sfs_02_0083__p218442133318">API</p>
@ -383,6 +383,35 @@
</table>
</div>
</div>
<div class="section" id="sfs_02_0083__section71223415713"><h4 class="sectiontitle">Tenant Quota Management</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0083__table138161926176" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0083__row681612268720"><th align="left" class="cellrowborder" valign="top" width="17.92698089747937%" id="mcps1.3.8.2.1.6.1.1"><p id="sfs_02_0083__p581662614713">Permission</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.984853622696964%" id="mcps1.3.8.2.1.6.1.2"><p id="sfs_02_0083__p1481622612717">API</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.323951622018768%" id="mcps1.3.8.2.1.6.1.3"><p id="sfs_02_0083__p1881612610719">Action</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.816661015033343%" id="mcps1.3.8.2.1.6.1.4"><p id="sfs_02_0083__p148161526875">Dependent Permission</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.947552842771563%" id="mcps1.3.8.2.1.6.1.5"><p id="sfs_02_0083__p1181612261772">IAM Project</p>
<p id="sfs_02_0083__p188163261076">(Project)</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0083__row7816142620712"><td class="cellrowborder" valign="top" width="17.92698089747937%" headers="mcps1.3.8.2.1.6.1.1 "><p id="sfs_02_0083__p23122341379">Querying Tenant Quotas</p>
</td>
<td class="cellrowborder" valign="top" width="21.984853622696964%" headers="mcps1.3.8.2.1.6.1.2 "><p id="sfs_02_0083__p3421143216546">GET /v1/{project_id}/sfs-turbo/quotas</p>
</td>
<td class="cellrowborder" valign="top" width="22.323951622018768%" headers="mcps1.3.8.2.1.6.1.3 "><p id="sfs_02_0083__p198161026670">sfsturbo:shares:getQuota</p>
</td>
<td class="cellrowborder" valign="top" width="25.816661015033343%" headers="mcps1.3.8.2.1.6.1.4 "><p id="sfs_02_0083__p88165269711">-</p>
</td>
<td class="cellrowborder" valign="top" width="11.947552842771563%" headers="mcps1.3.8.2.1.6.1.5 "><p id="sfs_02_0083__p3816192615719">√</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">

8
docs/sfs/api-ref/sfs_02_0092.html
View File

@ -8,7 +8,13 @@
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0092__row17448354115410"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="sfs_02_0092__p1939563414200">2025-04-07</p>
<tbody><tr id="sfs_02_0092__row101471048111115"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="sfs_02_0092__p1214764891114">2025-09-28</p>
</td>
<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.1.1.3.1.2 "><p id="sfs_02_0092__p20405422141620">Updated the following content:</p>
<p id="sfs_02_0092__p20405172212168">Added the description of tag-related APIs.</p>
</td>
</tr>
<tr id="sfs_02_0092__row17448354115410"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="sfs_02_0092__p1939563414200">2025-04-07</p>
</td>
<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.1.1.3.1.2 "><p id="sfs_02_0092__p4343101710219">Updated the following content:</p>
<ul id="sfs_02_0092__ul189112136363"><li id="sfs_02_0092__li791161383613">Added descriptions about General Purpose File System APIs.</li><li id="sfs_02_0092__li189111413133615">Updated section <a href="sfs_02_0083.html">SFS Turbo Actions</a>.</li></ul>

2
docs/sfs/api-ref/sfs_02_0110.html
View File

@ -9,6 +9,8 @@
</li>
<li class="ulchildlink"><strong><a href="sfs_02_0115.html">File System Access Rules</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="sfs_03_0001.html">Tags</a></strong><br>
</li>
</ul>
</div>

26
docs/sfs/api-ref/sfs_03_0001.html Normal file
View File

@ -0,0 +1,26 @@
<a name="sfs_03_0001"></a><a name="sfs_03_0001"></a>
<h1 class="topictitle1">Tags</h1>
<div id="body8662426"><p id="sfs_03_0001__en-us_topic_0000001840191458_p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="sfs_03_0002.html">Batch Adding Tags to a Resource</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="sfs_03_0003.html">Batch Deleting Tags from a Resource</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="sfs_03_0004.html">Querying Tags of a Resource</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="sfs_03_0005.html">Querying Resources by Tag</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="sfs_03_0006.html">Querying the Number of Resources by Tag</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="sfs_03_0007.html">Querying Tags in a Project</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="sfs_02_0110.html">General Purpose File System APIs (BETA)</a></div>
</div>
</div>

225
docs/sfs/api-ref/sfs_03_0002.html Normal file
View File

File diff suppressed because it is too large Load Diff

176
docs/sfs/api-ref/sfs_03_0003.html Normal file
View File

File diff suppressed because it is too large Load Diff

187
docs/sfs/api-ref/sfs_03_0004.html Normal file
View File

File diff suppressed because it is too large Load Diff

410
docs/sfs/api-ref/sfs_03_0005.html Normal file
View File

File diff suppressed because it is too large Load Diff

240
docs/sfs/api-ref/sfs_03_0006.html Normal file
View File

File diff suppressed because it is too large Load Diff

170
docs/sfs/api-ref/sfs_03_0007.html Normal file
View File

File diff suppressed because it is too large Load Diff

2
docs/sfs/api-ref/topic_300000000.html
View File

@ -11,7 +11,7 @@
</li>
<li class="ulchildlink"><strong><a href="DeleteShare.html">Deleting a File System</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ListShares.html">Obtaining the File System List</a></strong><br>
<li class="ulchildlink"><strong><a href="ListShares.html">Listing File Systems</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ExpandShare.html">Expanding the Capacity of a File System</a></strong><br>
</li>

8
docs/sfs/api-ref/topic_300000002.html
View File

@ -5,16 +5,18 @@
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="CreateSharedTag.html">Adding a Tag for a File System</a></strong><br>
<li class="ulchildlink"><strong><a href="CreateSharedTag.html">Adding a Tag to a File System</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ShowSharedTags.html">Querying Tags of a File System</a></strong><br>
<li class="ulchildlink"><strong><a href="ShowSharedTags.html">Querying All Tags of a File System</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="DeleteSharedTag.html">Deleting a Tag of a File System</a></strong><br>
<li class="ulchildlink"><strong><a href="DeleteSharedTag.html">Deleting a Tag from a File System</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="BatchAddSharedTags.html">Batch Adding Tags to a File System</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ListSharedTags.html">Querying Tags of All File Systems of a Tenant</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ListSharesByTag.html">Querying File Systems by Tag</a></strong><br>
</li>
</ul>
<div class="familylinks">

16
docs/sfs/api-ref/topic_300000004.html Normal file
View File

@ -0,0 +1,16 @@
<a name="topic_300000004"></a><a name="topic_300000004"></a>
<h1 class="topictitle1">File System Management</h1>
<div><p> </p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ShowClientIpInfo.html">Obtaining IP Addresses of the Clients Who Have Mounted the 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>

4
docs/sfs/api-ref/topic_300000007.html
View File

@ -9,11 +9,11 @@
</li>
<li class="ulchildlink"><strong><a href="ListPermRules.html">Querying Permission Rules of a File System</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ShowPermRule.html">Querying a Permission Rule by ID</a></strong><br>
<li class="ulchildlink"><strong><a href="ShowPermRule.html">Querying a Permission Rule of a File System</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="UpdatePermRule.html">Modifying a Permission Rule</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="DeletePermRule.html">Deleting a Permissions Rule</a></strong><br>
<li class="ulchildlink"><strong><a href="DeletePermRule.html">Deleting a Permission Rule</a></strong><br>
</li>
</ul>

2
docs/sfs/api-ref/topic_300000008.html
View File

@ -5,7 +5,7 @@
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ShowJobDetail.html">Querying Details About a Task</a></strong><br>
<li class="ulchildlink"><strong><a href="ShowJobDetail.html">Querying the Status of a Task</a></strong><br>
</li>
</ul>

16
docs/sfs/api-ref/topic_300000011.html Normal file
View File

@ -0,0 +1,16 @@
<a name="topic_300000011"></a><a name="topic_300000011"></a>
<h1 class="topictitle1">Tenant Quota Management</h1>
<div><p> </p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ShowQuota.html">Querying Tenant Quotas</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>