doc-exports/docs/sfs/api-ref/sfs_02_0041.html
zhangyue 8d1d100b18 SFS API DOC
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>
2023-09-05 08:16:37 +00:00

186 lines
14 KiB
HTML

<a name="sfs_02_0041"></a><a name="sfs_02_0041"></a>
<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 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>
<div class="section" id="sfs_02_0041__section1665327514513"><h4 class="sectiontitle">URI</h4><ul id="sfs_02_0041__ul673803814513"><li id="sfs_02_0041__li6064234314513">POST /v2/{project_id}/sfs/{share_id}/tags/action</li><li id="sfs_02_0041__li891018114513">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0041__table22021759152019" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0041__row16139965152019"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="sfs_02_0041__p17124101410431">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="sfs_02_0041__p1612415146430">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="sfs_02_0041__p312416148432">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="sfs_02_0041__p3124181464318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0041__row55089343152019"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0041__p1781134044818">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="sfs_02_0041__p59952126152019">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0041__p24284048152019">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0041__p20850895152019">Specifies the project ID of the operator.</p>
</td>
</tr>
<tr id="sfs_02_0041__row3119103219486"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0041__p1011933217487">share_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="sfs_02_0041__p18120163210481">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0041__p11120113294813">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0041__p13120143211489">Specifies the ID of the shared file system.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="sfs_02_0041__section5063604914513"><h4 class="sectiontitle">Request</h4><ul id="sfs_02_0041__ul787926514513"><li id="sfs_02_0041__li380452214513">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0041__table1836815510524" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0041__row1137265565217"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="sfs_02_0041__p18618102193316">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="sfs_02_0041__p116189212331">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="sfs_02_0041__p1961872118337">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="sfs_02_0041__p11618162103318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0041__row1476962172917"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0041__p1876919212918">action</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0041__p1276919232920">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0041__p10769112142919">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0041__p197694202910">Specifies the operation identifier. Possible values are <strong id="sfs_02_0041__b842352706192333">create</strong> and <strong id="sfs_02_0041__b842352706192336">delete</strong>. Use <strong id="sfs_02_0041__b1655924829192352">create</strong> to batch add tags to a specified shared file system.</p>
</td>
</tr>
<tr id="sfs_02_0041__row8379125520523"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0041__p13380755115210">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0041__p1038255513523">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0041__p18383165518521">Array of resource_tags</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0041__p938455505218">Specifies the tag list.</p>
<p id="sfs_02_0041__p1673311911399">This parameter is mandatory when the tenant permission is used. For the op_service permission, choose either this field or <strong id="sfs_02_0041__b61898389371">sys_tags</strong>.</p>
</td>
</tr>
<tr id="sfs_02_0041__row1190711903815"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0041__p1143742223818">sys_tags</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0041__p14437182293810">No</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0041__p4437142283816">Array of resource_tags</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0041__p194371522163815">Specifies the system tag list.</p>
<p id="sfs_02_0041__p54371022143812">This field is available only to the op_service permission. Choose either this field or <strong id="sfs_02_0041__b829912156397">tags</strong>.</p>
<p id="sfs_02_0041__p104374229387">Only one resource_tag structure key, <strong id="sfs_02_0041__b165451122122714">_sys_enterprise_project_id</strong>, is used in TMS calls.</p>
<p id="sfs_02_0041__p10437022143814">The value is <strong id="sfs_02_0041__b842352706143649">ID</strong> or <strong id="sfs_02_0041__b842352706143652">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="sfs_02_0041__li1987803112910">Description of field <strong id="sfs_02_0041__b129301825169">resource_tag</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0041__table14385185545214" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0041__row5389135517522"><th align="left" class="cellrowborder" valign="top" width="17.17171717171717%" id="mcps1.3.3.2.2.2.1.5.1.1"><p id="sfs_02_0041__p346222643313">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.13131313131313%" id="mcps1.3.3.2.2.2.1.5.1.2"><p id="sfs_02_0041__p104621926173313">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.17171717171717%" id="mcps1.3.3.2.2.2.1.5.1.3"><p id="sfs_02_0041__p346212673314">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.52525252525252%" id="mcps1.3.3.2.2.2.1.5.1.4"><p id="sfs_02_0041__p146217263333">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0041__row10396165515211"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="sfs_02_0041__p7397185512522">key</p>
</td>
<td class="cellrowborder" valign="top" width="13.13131313131313%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="sfs_02_0041__p19398125516523">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="sfs_02_0041__p18399255165215">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.52525252525252%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="sfs_02_0041__p14400185515528">Specifies the tag key. The value can contain a maximum of 36 characters. The key cannot be left blank and can only contain letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="sfs_02_0041__row144011055105210"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="sfs_02_0041__p144021355135210">value</p>
</td>
<td class="cellrowborder" valign="top" width="13.13131313131313%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="sfs_02_0041__p1640495512522">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="sfs_02_0041__p16405255185213">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.52525252525252%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="sfs_02_0041__p240685517526">Specifies the tag value. The value contains a maximum of 43 characters and can be an empty string. It can only contain letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
</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": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
}
]
}</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>
</li></ul>
<ul id="sfs_02_0041__ul3903357014513"><li id="sfs_02_0041__li1575781314513">Example response<p id="sfs_02_0041__p138241544115414"><a name="sfs_02_0041__li1575781314513"></a><a name="li1575781314513"></a>None</p>
</li></ul>
</div>
<div class="section" id="sfs_02_0041__section4959408514513"><h4 class="sectiontitle">Status Codes</h4><ul id="sfs_02_0041__ul5769798014513"><li id="sfs_02_0041__li4951977214513">Normal<p id="sfs_02_0041__p4302476614513"><a name="sfs_02_0041__li4951977214513"></a><a name="li4951977214513"></a>204</p>
</li><li id="sfs_02_0041__li5167858014513">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0041__table6245403714513" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0041__row1507735814513"><th align="left" class="cellrowborder" valign="top" width="43.43%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="sfs_02_0041__p1330652014513">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="sfs_02_0041__p408636314513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0041__row3477393214513"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0041__p6522508214513">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="sfs_02_0041__p4874025614513">Invalid value.</p>
</td>
</tr>
<tr id="sfs_02_0041__row3600912414513"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0041__p3105792214513">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="sfs_02_0041__p3266375714513">Authentication failed.</p>
</td>
</tr>
<tr id="sfs_02_0041__row2553835814513"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0041__p5534113514513">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="sfs_02_0041__p5344692014513">Access to the requested page is forbidden.</p>
</td>
</tr>
<tr id="sfs_02_0041__row1126023214513"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0041__p3966357214513">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="sfs_02_0041__p5863278914513">The requested resource was not found.</p>
</td>
</tr>
<tr id="sfs_02_0041__row1011562214513"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0041__p1405905414513">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="sfs_02_0041__p6504160314513">The request is not completed because of a service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="sfs_02_0036.html">Tag Management</a></div>
</div>
</div>