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

SFS API DOC

Browse Source 
Reviewed-by: Miskanin, Jan <jan.miskanin@t-systems.com>
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
This commit is contained in:
zhangyue 2023-09-05 08:16:37 +00:00 committed by zuul
parent 6bc3e27a00
commit 8d1d100b18
19 changed files with 1485 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

227
docs/sfs/api-ref/en-us_topic_0000001614397248.html Normal file
View File

File diff suppressed because it is too large Load Diff

186
docs/sfs/api-ref/en-us_topic_0000001614557076.html Normal file
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

269
docs/sfs/api-ref/en-us_topic_0000001662997101.html Normal file
View File

File diff suppressed because it is too large Load Diff

23
docs/sfs/api-ref/en-us_topic_0000001663116961.html Normal file
View File

@ -0,0 +1,23 @@
<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>

336
docs/sfs/api-ref/en-us_topic_0000001663156945.html Normal file
View File

File diff suppressed because it is too large Load Diff

10
docs/sfs/api-ref/sfs_02_0021.html
View File

@ -180,11 +180,11 @@
</tbody>
</table>
</div>
<div class="note" id="sfs_02_0021__note145511262113"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="sfs_02_0021__ul14877161311128"><li id="sfs_02_0021__li167881119151216">You are advised to use the default primary key <strong id="sfs_02_0021__b842352706155015">sfs/default</strong> to create an encrypted shared file system. For details, see section "File System Encryption" and "Encryption" in the <em id="sfs_02_0021__i842352697155222">Scalable File Service User Guide</em>.</li></ul>
<div class="note" id="sfs_02_0021__note145511262113"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="sfs_02_0021__ul14877161311128"><li id="sfs_02_0021__li167881119151216">You are advised to use the default key <strong id="sfs_02_0021__b842352706155015">sfs/default</strong> to create an encrypted shared file system. For details, see section "File System Encryption" and "Encryption" in the <em id="sfs_02_0021__i842352697155222">Scalable File Service User Guide</em>.</li></ul>
</div></div>
</div>
</li></ul>
<ul id="sfs_02_0021__ue62a04435aa442409ac8ab9192da1e04"><li id="sfs_02_0021__li31136547374">Example request: POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares<pre class="screen" id="sfs_02_0021__s79d94e9838f24d9cba369cce3b4e19f1">{
<ul id="sfs_02_0021__ue62a04435aa442409ac8ab9192da1e04"><li id="sfs_02_0021__li31136547374">Example request: POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares<div class="p" id="sfs_02_0021__p7709235144212"><a name="sfs_02_0021__li31136547374"></a><a name="li31136547374"></a>Creating a 1-GB NFS file system that can only be seen privately<pre class="screen" id="sfs_02_0021__s79d94e9838f24d9cba369cce3b4e19f1">{
"share": {
"name": "test",
"description": "test description",
@ -194,9 +194,10 @@
"is_public": false
}
}</pre>
</div>
</li></ul>
</div>
<ul id="sfs_02_0021__ul8349113524212"><li id="sfs_02_0021__li735293574218">Example request (creating a shared file system with data encryption function): POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares<pre class="screen" id="sfs_02_0021__screen14359935184218">{
<ul id="sfs_02_0021__ul8349113524212"><li id="sfs_02_0021__li735293574218">Example request (creating a shared file system with data encryption function): POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares<div class="p" id="sfs_02_0021__p1680432913466"><a name="sfs_02_0021__li735293574218"></a><a name="li735293574218"></a>Creating a 1-GB, encrypted NFS file system that can only be seen privately<pre class="screen" id="sfs_02_0021__screen14359935184218">{
"share": {
"name": "test",
"description": "test description",
@ -211,6 +212,7 @@
"is_public": false
}
}</pre>
</div>
</li></ul>
<div class="section" id="sfs_02_0021__s1487e0d77aa44726b32e39e9b52b242b"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0021__ua5fd9d292aba421d83908b0a9ea74388"><li id="sfs_02_0021__l76a6c845449547328651e110a15a103f">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0021__tda30386a6e9d4540a4eb716742253a1b" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0021__r8ada73019fa5407c8e16f6e1f7bc4bb1"><th align="left" class="cellrowborder" valign="top" width="16.93830616938306%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="sfs_02_0021__p88858351506">Parameter</p>
@ -231,7 +233,7 @@
</tbody>
</table>
</div>
</li><li id="sfs_02_0021__li85221729152117">Description of the <strong id="sfs_02_0021__b72777287">share</strong> field
</li><li id="sfs_02_0021__li85221729152117">Description of the <strong id="sfs_02_0021__b547506798">share</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0021__en-us_topic_0064390794_table28597308" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0021__en-us_topic_0064390794_row26120409"><th align="left" class="cellrowborder" valign="top" width="18.84%" id="mcps1.3.5.2.2.2.1.4.1.1"><p id="sfs_02_0021__p1873317135612">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.91%" id="mcps1.3.5.2.2.2.1.4.1.2"><p id="sfs_02_0021__p473111755617">Type</p>

5
docs/sfs/api-ref/sfs_02_0037.html
View File

@ -2,7 +2,7 @@
<h1 class="topictitle1">Adding a Tag to a Shared File System</h1>
<div id="body1521093540922"><div class="section" id="sfs_02_0037__section10684447163819"><h4 class="sectiontitle">Function</h4><p id="sfs_02_0037__p531134294716">This API is used to add a tag to a specified shared file system.</p>
<p id="sfs_02_0037__p2311242164717">A shared file system can have a maximum of 10 tags.</p>
<p id="sfs_02_0037__p2311242164717">A shared file system can have a maximum of 20 tags.</p>
<p id="sfs_02_0037__p4311542204718">The keys of multiple tags added to a shared file system must be unique.</p>
<p id="sfs_02_0037__p1331342114719">This API is idempotent. If the key to be added has already been added to the shared file system, the tag is updated.</p>
</div>
@ -95,12 +95,13 @@
</tbody>
</table>
</div>
</li><li id="sfs_02_0037__li3973086014513">Example request<pre class="screen" id="sfs_02_0037__screen1279212312533">{
</li><li id="sfs_02_0037__li3973086014513">Example request<div class="p" id="sfs_02_0037__p19891125810597"><a name="sfs_02_0037__li3973086014513"></a><a name="li3973086014513"></a>Adding a tag (key1, value1) to a shared file system<pre class="screen" id="sfs_02_0037__screen1279212312533">{
"tag" : {
"key" : "key1",
"value" : "value1"
}
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="sfs_02_0037__section6408307814513"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0037__ul2334684914513"><li id="sfs_02_0037__li879505414513">Parameter description<p id="sfs_02_0037__ac213f604d5cf4e85a07dd78f95b5205b"><a name="sfs_02_0037__li879505414513"></a><a name="li879505414513"></a>None</p>

5
docs/sfs/api-ref/sfs_02_0041.html
View File

@ -2,7 +2,7 @@
<h1 class="topictitle1">Batch Adding Tags to a Shared File System</h1>
<div id="body1521093540922"><div class="section" id="sfs_02_0041__section10684447163819"><h4 class="sectiontitle">Function</h4><p id="sfs_02_0041__p7378165510518">This API is used to batch add tags to a shared file system.</p>
<p id="sfs_02_0041__p14805141517617">A shared file system can have a maximum of 10 tags.</p>
<p id="sfs_02_0041__p14805141517617">A shared file system can have a maximum of 20 tags.</p>
<p id="sfs_02_0041__p580531511613">The keys of multiple tags added to a shared file system must be unique.</p>
<p id="sfs_02_0041__p20805141511620">This API is idempotent. If the key to be added has already been added to the shared file system, the tag is updated.</p>
</div>
@ -117,7 +117,7 @@
</tbody>
</table>
</div>
</li><li id="sfs_02_0041__li3973086014513">Example request<pre class="screen" id="sfs_02_0041__screen131925450281">{
</li><li id="sfs_02_0041__li3973086014513">Example request<div class="p" id="sfs_02_0041__p3747205617"><a name="sfs_02_0041__li3973086014513"></a><a name="li3973086014513"></a>Batch adding tags (key1, value1 and key2, value2) to a shared file system<pre class="screen" id="sfs_02_0041__screen131925450281">{
"action": "create",
"tags": [
{
@ -130,6 +130,7 @@
}
]
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="sfs_02_0041__section6408307814513"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0041__ul2334684914513"><li id="sfs_02_0041__li879505414513">Parameter description<p id="sfs_02_0041__ac213f604d5cf4e85a07dd78f95b5205b"><a name="sfs_02_0041__li879505414513"></a><a name="li879505414513"></a>None</p>

3
docs/sfs/api-ref/sfs_02_0042.html
View File

@ -104,7 +104,7 @@
</tbody>
</table>
</div>
</li><li id="sfs_02_0042__li3973086014513">Example request<pre class="screen" id="sfs_02_0042__screen131925450281">{
</li><li id="sfs_02_0042__li3973086014513">Example request<div class="p" id="sfs_02_0042__p2418113810217"><a name="sfs_02_0042__li3973086014513"></a><a name="li3973086014513"></a>Batch deleting tags (key1, value1; key2; key3) from a shared file system<pre class="screen" id="sfs_02_0042__screen131925450281">{
"action": "delete",
"tags": [
{
@ -120,6 +120,7 @@
}
]
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="sfs_02_0042__section1060474015305"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0042__ul2334684914513"><li id="sfs_02_0042__li879505414513">Parameter description<p id="sfs_02_0042__ac213f604d5cf4e85a07dd78f95b5205b"><a name="sfs_02_0042__li879505414513"></a><a name="li879505414513"></a>None</p>

11
docs/sfs/api-ref/sfs_02_0043.html
View File

@ -83,7 +83,7 @@
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0043__p1673521118110">Array of tags</p>
</td>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0043__p16333162443616">Specifies the tag search field, which is a list of tags. Only shared file systems containing all the listed tags can be returned. Tags in this search criteria are in the AND relationship. Specifically, a shared file system can be searched only when it meets all the tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0043__b97747015105">tags</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0043__p16333162443616">Specifies the tag search field, which is a list of tags. Only shared file systems containing all the listed tags can be returned. Tags in this search criteria are in the AND relationship. Specifically, a shared file system can be searched only when it meets all the tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0043__b97747015105">tags</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 20 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
</td>
</tr>
<tr id="sfs_02_0043__row27613205290"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0043__p17989173462918">tags_any</p>
@ -92,7 +92,7 @@
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0043__p1999623412911">Array of tags</p>
</td>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0043__p8191134114119">Specifies the tag search field, which is a list of tags. Shared file systems that contain any listed tag will be returned. Tags in this search criteria are in the OR relationship. Specifically, a shared file system can be searched as long as it meets one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0043__b1468823103513">tags_any</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0043__p8191134114119">Specifies the tag search field, which is a list of tags. Shared file systems that contain any listed tag will be returned. Tags in this search criteria are in the OR relationship. Specifically, a shared file system can be searched as long as it meets one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0043__b1468823103513">tags_any</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 20 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
</td>
</tr>
<tr id="sfs_02_0043__row520617114308"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0043__p102065115306">not_tags</p>
@ -101,7 +101,7 @@
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0043__p1794353214118">Array of tags</p>
</td>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0043__p46818135493">Specifies the tag search field, which is a list of tags. Only shared file systems that contain none of the listed tags will be returned. Tags in this search criteria are in the NOR relationship. Specifically, a shared file system can be searched only when it does not meet any tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0043__b560215593352">not_tags</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0043__p46818135493">Specifies the tag search field, which is a list of tags. Only shared file systems that contain none of the listed tags will be returned. Tags in this search criteria are in the NOR relationship. Specifically, a shared file system can be searched only when it does not meet any tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0043__b560215593352">not_tags</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 20 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
</td>
</tr>
<tr id="sfs_02_0043__row5651747303"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0043__p5651446302">not_tags_any</p>
@ -110,7 +110,7 @@
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0043__p619611362110">Array of tags</p>
</td>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0043__p460582620498">Specifies the tag search field, which is a list of tags. Shared file systems that do not contain any of the listed tags will be returned. Tags in this search criteria are in the NAND relationship. Specifically, a shared file system can be searched as long as it does not meet one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0043__b988895881810">not_tags_any</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0043__p460582620498">Specifies the tag search field, which is a list of tags. Shared file systems that do not contain any of the listed tags will be returned. Tags in this search criteria are in the NAND relationship. Specifically, a shared file system can be searched as long as it does not meet one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0043__b988895881810">not_tags_any</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 20 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
</td>
</tr>
<tr id="sfs_02_0043__row22616012115"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0043__p15261303211">sys_tags</p>
@ -192,7 +192,7 @@
</tbody>
</table>
</div>
</li><li id="sfs_02_0043__li3973086014513">Example request<pre class="screen" id="sfs_02_0043__screen1279212312533">{
</li><li id="sfs_02_0043__li3973086014513">Example request<div class="p" id="sfs_02_0043__p2814428417"><a name="sfs_02_0043__li3973086014513"></a><a name="li3973086014513"></a>Querying shared file systems using tag (key1, value2)<pre class="screen" id="sfs_02_0043__screen1279212312533">{
"offset": "0",
"limit": "100",
"action": "filter",
@ -229,6 +229,7 @@
"values": []
}]
}</pre>
</div>
</li></ul>
</div>
<ul id="sfs_02_0043__ul102741831569"><li id="sfs_02_0043__li387731912111">Example request (without passing <strong id="sfs_02_0043__b1175615117119">matches</strong>)<pre class="screen" id="sfs_02_0043__screen1567582711112">{

20
docs/sfs/api-ref/sfs_02_0044.html
View File

@ -64,7 +64,7 @@
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0044__p14130102182017">Array of tags</p>
</td>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0044__p16333162443616">Specifies the tag search field, which is a list of tags. Only shared file systems containing all the listed tags can be returned. Tags in this search criteria are in the AND relationship. Specifically, a shared file system can be searched only when it meets all the tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0044__b10421153017244">tags</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0044__p16333162443616">Specifies the tag search field, which is a list of tags. Only shared file systems containing all the listed tags can be returned. Tags in this search criteria are in the AND relationship. Specifically, a shared file system can be searched only when it meets all the tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0044__b10421153017244">tags</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 20 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
</td>
</tr>
<tr id="sfs_02_0044__row128182814538"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0044__p17989173462918">tags_any</p>
@ -73,7 +73,7 @@
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0044__p4650203210320">Array of tags</p>
</td>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0044__p8191134114119">Specifies the tag search field, which is a list of tags. Shared file systems that contain any listed tag will be returned. Tags in this search criteria are in the OR relationship. Specifically, a shared file system can be searched as long as it meets one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0044__b217184119169">tags_any</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0044__p8191134114119">Specifies the tag search field, which is a list of tags. Shared file systems that contain any listed tag will be returned. Tags in this search criteria are in the OR relationship. Specifically, a shared file system can be searched as long as it meets one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0044__b217184119169">tags_any</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 20 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
</td>
</tr>
<tr id="sfs_02_0044__row64553645313"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0044__p102065115306">not_tags</p>
@ -82,7 +82,7 @@
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0044__p42796356319">Array of tags</p>
</td>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0044__p46818135493">Specifies the tag search field, which is a list of tags. Only shared file systems that contain none of the listed tags will be returned. Tags in this search criteria are in the NOR relationship. Specifically, a shared file system can be searched only when it does not meet any tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0044__b132411321178">not_tags</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0044__p46818135493">Specifies the tag search field, which is a list of tags. Only shared file systems that contain none of the listed tags will be returned. Tags in this search criteria are in the NOR relationship. Specifically, a shared file system can be searched only when it does not meet any tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0044__b132411321178">not_tags</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 20 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
</td>
</tr>
<tr id="sfs_02_0044__row192681840145316"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0044__p5651446302">not_tags_any</p>
@ -91,7 +91,7 @@
</td>
<td class="cellrowborder" valign="top" width="15.151515151515152%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0044__p209881837939">Array of tags</p>
</td>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0044__p460582620498">Specifies the tag search field, which is a list of tags. Shared file systems that do not contain any of the listed tags will be returned. Tags in this search criteria are in the NAND relationship. Specifically, a shared file system can be searched as long as it does not meet one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0044__b459375741812">not_tags_any</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
<td class="cellrowborder" valign="top" width="52.52525252525253%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0044__p460582620498">Specifies the tag search field, which is a list of tags. Shared file systems that do not contain any of the listed tags will be returned. Tags in this search criteria are in the NAND relationship. Specifically, a shared file system can be searched as long as it does not meet one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0044__b459375741812">not_tags_any</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 20 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
</td>
</tr>
<tr id="sfs_02_0044__row4821263355"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0044__p15261303211">sys_tags</p>
@ -174,7 +174,7 @@
</tbody>
</table>
</div>
</li><li id="sfs_02_0044__li3973086014513">Example request<pre class="screen" id="sfs_02_0044__screen1279212312533">{
</li><li id="sfs_02_0044__li3973086014513">Example request<div class="p" id="sfs_02_0044__p46083411209"><a name="sfs_02_0044__li3973086014513"></a><a name="li3973086014513"></a>Querying the number of shared file systems (file system name <strong id="sfs_02_0044__b144081537172114">share_name</strong>) using tag (key1, value2)<pre class="screen" id="sfs_02_0044__screen1279212312533">{
"action": "count",
"matches": [{
"key": "resource_name",
@ -209,9 +209,10 @@
"values": []
}]
}</pre>
</div>
</li></ul>
</div>
<ul id="sfs_02_0044__ul199241627104"><li id="sfs_02_0044__li514815131944">Example request (without passing <strong id="sfs_02_0044__b18898847155815">matches</strong>)<pre class="screen" id="sfs_02_0044__screen1124641414411">{
<ul id="sfs_02_0044__ul199241627104"><li id="sfs_02_0044__li514815131944">Example request (without passing <strong id="sfs_02_0044__b18898847155815">matches</strong>)<div class="p" id="sfs_02_0044__p11791750142310">Querying the number of shared file systems using tag (key1, value2)<pre class="screen" id="sfs_02_0044__screen1124641414411">{
"action": "count",
"tags": [{
"key": "key1",
@ -221,17 +222,20 @@
"values": []
}]
}</pre>
</li><li id="sfs_02_0044__li550013619017">Example request (without passing <strong id="sfs_02_0044__b48331561333">tags</strong>, <strong id="sfs_02_0044__b108341565312">not_tags</strong>, <strong id="sfs_02_0044__b1884896334">tags_any</strong>, and <strong id="sfs_02_0044__b9848564310">not_tags_any</strong>)<pre class="screen" id="sfs_02_0044__screen1750363612018">{
</div>
</li><li id="sfs_02_0044__li550013619017">Example request (without passing <strong id="sfs_02_0044__b48331561333">tags</strong>, <strong id="sfs_02_0044__b108341565312">not_tags</strong>, <strong id="sfs_02_0044__b1884896334">tags_any</strong>, and <strong id="sfs_02_0044__b9848564310">not_tags_any</strong>)<div class="p" id="sfs_02_0044__p104168211249">Querying the number of shared file systems (file system name <strong id="sfs_02_0044__b96151316172214">share_name</strong>)<pre class="screen" id="sfs_02_0044__screen1750363612018">{
"action": "count",
"matches": [{
"key": "resource_name",
"value": "share_name"
}]
}</pre>
</div>
</li></ul>
<ul id="sfs_02_0044__ul127127121077"><li id="sfs_02_0044__li137145126711">Example request (with the <strong id="sfs_02_0044__b1426711122035">action</strong> field only)<pre class="screen" id="sfs_02_0044__screen1171810125712">{
<ul id="sfs_02_0044__ul127127121077"><li id="sfs_02_0044__li137145126711">Example request (with the <strong id="sfs_02_0044__b1426711122035">action</strong> field only)<div class="p" id="sfs_02_0044__p6462178112310">Querying the total number of shared file systems of the tenant<pre class="screen" id="sfs_02_0044__screen1171810125712">{
"action": "count"
}</pre>
</div>
</li></ul>
<div class="section" id="sfs_02_0044__section6408307814513"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0044__ul2334684914513"><li id="sfs_02_0044__li879505414513">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0044__table146375523240" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0044__row1268155212411"><th align="left" class="cellrowborder" valign="top" width="26.31736826317368%" id="mcps1.3.6.2.1.1.1.4.1.1"><p id="sfs_02_0044__p18129185585413">Parameter</p>

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

@ -14,6 +14,8 @@
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0000001537230113.html">Name Management</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0000001663116961.html">Permissions Management</a></strong><br>
</li>
</ul>
</div>

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

@ -2,7 +2,7 @@
<h1 class="topictitle1">Adding a Tag to a File System</h1>
<div id="body1572053639618"><div class="section" id="sfs_02_0075__section19952658227"><h4 class="sectiontitle">Function</h4><p id="sfs_02_0075__p6238135915210">This API is used to add a tag to an SFS Turbo file system.</p>
<p id="sfs_02_0075__p723812591922">A shared file system can have a maximum of 10 tags.</p>
<p id="sfs_02_0075__p723812591922">A shared file system can have a maximum of 20 tags.</p>
<p id="sfs_02_0075__p423817591326">The keys of multiple tags added to a shared file system must be unique.</p>
<p id="sfs_02_0075__p423820596210">This API is idempotent. If the key to be added has already been added to the shared file system, the tag is updated.</p>
</div>

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

@ -2,7 +2,7 @@
<h1 class="topictitle1">Batch Adding Tags to a File System</h1>
<div id="body1572053639618"><div class="section" id="sfs_02_0078__section65483112161"><h4 class="sectiontitle">Function</h4><p id="sfs_02_0078__p10335193111161">This API is used to batch add tags to an SFS Turbo file system.</p>
<p id="sfs_02_0078__p193353316163">A shared file system can have a maximum of 10 tags.</p>
<p id="sfs_02_0078__p193353316163">A shared file system can have a maximum of 20 tags.</p>
<p id="sfs_02_0078__p173351131111617">The keys of multiple tags added to a shared file system must be unique.</p>
<p id="sfs_02_0078__p123355313165">This API is idempotent. If the key to be added has already been added to the shared file system, the tag is updated.</p>
</div>

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

@ -8,7 +8,19 @@
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0092__row6443431846"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="sfs_02_0092__p17443183941">2023-02-20</p>
<tbody><tr id="sfs_02_0092__row116111964013"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="sfs_02_0092__p181613198409">2023-08-09</p>
</td>
<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.1.1.3.1.2 "><p id="sfs_02_0092__p316110190409">Updated the following content:</p>
<p id="sfs_02_0092__p4405233184012">Modified the maximum number of tags that can be added to a file system in SFS Turbo tag APIs.</p>
</td>
</tr>
<tr id="sfs_02_0092__row8176738451"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="sfs_02_0092__p4177113813516">2023-07-28</p>
</td>
<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.1.1.3.1.2 "><p id="sfs_02_0092__p15177738158">Updated the following content:</p>
<p id="sfs_02_0092__p488319524517">Added section <a href="en-us_topic_0000001663116961.html">Permissions Management</a>.</p>
</td>
</tr>
<tr id="sfs_02_0092__row6443431846"><td class="cellrowborder" valign="top" width="23.830000000000002%" headers="mcps1.3.1.1.3.1.1 "><p id="sfs_02_0092__p17443183941">2023-02-20</p>
</td>
<td class="cellrowborder" valign="top" width="76.17%" headers="mcps1.3.1.1.3.1.2 "><p id="sfs_02_0092__p444383844">Updated the following content:</p>
<p id="sfs_02_0092__p1633395255">Added descriptions of permissions and actions.</p>

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

@ -83,7 +83,7 @@
</td>
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0095__p1673521118110">Array of tags</p>
</td>
<td class="cellrowborder" valign="top" width="57.57575757575757%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0095__p16333162443616">Specifies the tag search field, which is a list of tags. Only shared file systems that contain all the listed tags can be returned. Tags in this search criteria are in the AND relationship. Specifically, a shared file system can be searched only when it meets all the tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0095__b192348598431">tags</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
<td class="cellrowborder" valign="top" width="57.57575757575757%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0095__p16333162443616">Specifies the tag search field, which is a list of tags. Only shared file systems that contain all the listed tags can be returned. Tags in this search criteria are in the AND relationship. Specifically, a shared file system can be searched only when it meets all the tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0095__b192348598431">tags</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 20 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
</td>
</tr>
<tr id="sfs_02_0095__row27613205290"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0095__p17989173462918">tags_any</p>
@ -92,7 +92,7 @@
</td>
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0095__p1999623412911">Array of tags</p>
</td>
<td class="cellrowborder" valign="top" width="57.57575757575757%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0095__p8191134114119">Specifies the tag search field, which is a list of tags. Shared file systems that contain any listed tag will be returned. Tags in this search criteria are in the OR relationship. Specifically, a shared file system can be searched as long as it meets one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0095__b11824522174513">tags_any</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
<td class="cellrowborder" valign="top" width="57.57575757575757%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0095__p8191134114119">Specifies the tag search field, which is a list of tags. Shared file systems that contain any listed tag will be returned. Tags in this search criteria are in the OR relationship. Specifically, a shared file system can be searched as long as it meets one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0095__b11824522174513">tags_any</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 20 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
</td>
</tr>
<tr id="sfs_02_0095__row520617114308"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0095__p102065115306">not_tags</p>
@ -101,7 +101,7 @@
</td>
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0095__p1794353214118">Array of tags</p>
</td>
<td class="cellrowborder" valign="top" width="57.57575757575757%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0095__p46818135493">Specifies the tag search field, which is a list of tags. Only shared file systems that contain none of the listed tags will be returned. Tags in this search criteria are in the NOR relationship. Specifically, a shared file system can be searched only when it does not meet any tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0095__b1730134814513">not_tags</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
<td class="cellrowborder" valign="top" width="57.57575757575757%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0095__p46818135493">Specifies the tag search field, which is a list of tags. Only shared file systems that contain none of the listed tags will be returned. Tags in this search criteria are in the NOR relationship. Specifically, a shared file system can be searched only when it does not meet any tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0095__b1730134814513">not_tags</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 20 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
</td>
</tr>
<tr id="sfs_02_0095__row5651747303"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0095__p5651446302">not_tags_any</p>
@ -110,7 +110,7 @@
</td>
<td class="cellrowborder" valign="top" width="12.121212121212121%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0095__p619611362110">Array of tags</p>
</td>
<td class="cellrowborder" valign="top" width="57.57575757575757%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0095__p460582620498">Specifies the tag search field, which is a list of tags. Shared file systems that do not contain any of the listed tags will be returned. Tags in this search criteria are in the NAND relationship. Specifically, a shared file system can be searched as long as it does not meet one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0095__b1670102912468">not_tags_any</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
<td class="cellrowborder" valign="top" width="57.57575757575757%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0095__p460582620498">Specifies the tag search field, which is a list of tags. Shared file systems that do not contain any of the listed tags will be returned. Tags in this search criteria are in the NAND relationship. Specifically, a shared file system can be searched as long as it does not meet one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of <strong id="sfs_02_0095__b1670102912468">not_tags_any</strong> is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 20 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.</p>
</td>
</tr>
<tr id="sfs_02_0095__row22616012115"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0095__p15261303211">sys_tags</p>