forked from laiweijian4/doc-exports
zhangyue
5d0d5cb580
Reviewed-by: Muller, Martin <martin.muller@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
446 lines
34 KiB
HTML
446 lines
34 KiB
HTML
<a name="sfs_02_0043"></a><a name="sfs_02_0043"></a>
|
|
|
|
<h1 class="topictitle1">Querying Shared File Systems by Tag</h1>
|
|
<div id="body1521093540922"><div class="section" id="sfs_02_0043__section10684447163819"><h4 class="sectiontitle">Function</h4><p id="sfs_02_0043__p93025151384">This API is used to query shared file systems by tag.</p>
|
|
</div>
|
|
<div class="section" id="sfs_02_0043__section1665327514513"><h4 class="sectiontitle">URI</h4><ul id="sfs_02_0043__ul673803814513"><li id="sfs_02_0043__li470221521416">POST /v2/{project_id}/sfs/resource_instances/action</li><li id="sfs_02_0043__li6064234314513">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0043__table22021759152019" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0043__row16139965152019"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="sfs_02_0043__p17124101410431">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="sfs_02_0043__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_0043__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_0043__p3124181464318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sfs_02_0043__row55089343152019"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0043__p1781134044818">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="sfs_02_0043__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_0043__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_0043__p20850895152019">Specifies the project ID of the operator.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sfs_02_0043__section5063604914513"><h4 class="sectiontitle">Request</h4><ul id="sfs_02_0043__ul787926514513"><li id="sfs_02_0043__li380452214513">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0043__table1836815510524" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0043__row1137265565217"><th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="sfs_02_0043__p450961573411">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.161616161616163%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="sfs_02_0043__p125092153348">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.151515151515152%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="sfs_02_0043__p1950918155341">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.52525252525253%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="sfs_02_0043__p115091615173411">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sfs_02_0043__row8379125520523"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0043__p163764151018">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0043__p175801621814">No</p>
|
|
</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__p18383165518521">String</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__p938455505218">Specifies the index location. The value is a character string consisting of 0 and positive integers. The default value is <strong id="sfs_02_0043__b842352706102044">0</strong>. The first record in the query result is the offset+1 record that meets the query criteria. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row0237959107"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0043__p72376592019">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0043__p223765914017">No</p>
|
|
</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__p22371591205">String</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__p16788162213172">Specifies the maximum number of query records. The value is a character string consisting of integers. The default value is <strong id="sfs_02_0043__b84235270617408">1000</strong>. The value ranges from <strong id="sfs_02_0043__b926712171409">1</strong> to <strong id="sfs_02_0043__b10987519154014">1000</strong>.</p>
|
|
<p id="sfs_02_0043__p183708303178">The number of returned records cannot exceed the value of <strong id="sfs_02_0043__b83727015712">limit</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row169449467189"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0043__p79441546101814">action</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0043__p10944446111819">Yes</p>
|
|
</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__p4944546111812">String</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__p2732171413197">Specifies the operation identifier. Possible values are <strong id="sfs_02_0043__b842352706194826">filter</strong> and <strong id="sfs_02_0043__b842352706194830">count</strong>. </p>
|
|
<p id="sfs_02_0043__p117321414121911">Use <strong id="sfs_02_0043__b1500963531194839">filter</strong> to query details of a shared file system using tags.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row1336510521186"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0043__p1436585213188">matches</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0043__p14365165201817">No</p>
|
|
</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__p936575219188">Array of matches</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__p728211260546">Specifies the file system query field. If this parameter is left null, all shared file systems of the tenant are searched by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row113011219209"><td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0043__p31307213203">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0043__p181301524209">No</p>
|
|
</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>
|
|
</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>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0043__p2993834172910">No</p>
|
|
</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>
|
|
</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>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0043__p8200161814304">No</p>
|
|
</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>
|
|
</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>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0043__p19414193412306">No</p>
|
|
</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>
|
|
</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>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.161616161616163%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0043__p1126110016219">No</p>
|
|
</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__p84989317238">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__p4451840122313">Only the op_service permission can use this field to filter resources.</p>
|
|
<ol id="sfs_02_0043__ol1745740192319"><li id="sfs_02_0043__li44594012237">Currently, TMS can invoke only one tag structure key, <strong id="sfs_02_0043__b14988854174116">_sys_enterprise_project_id</strong>.</li><li id="sfs_02_0043__li1545104014231">Currently, <strong id="sfs_02_0043__b13702142719416">key</strong> contains only one value.</li><li id="sfs_02_0043__li1811104902312"><strong id="sfs_02_0043__b11675804193">sys_tags</strong> and tenant tag filtering conditions (<strong id="sfs_02_0043__b171831943151919">tags</strong>, <strong id="sfs_02_0043__b14395134713191">tags_any</strong>, <strong id="sfs_02_0043__b1850712509192">not_tags</strong>, and <strong id="sfs_02_0043__b858795419195">not_tags_any</strong>) cannot be used at the same time.</li></ol>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="notice" id="sfs_02_0043__note189211339141913"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="sfs_02_0043__p17921163911198">In the request parameters, tag search fields <strong id="sfs_02_0043__b9413133781313">tags</strong>, <strong id="sfs_02_0043__b1415113710138">tags_any</strong>, <strong id="sfs_02_0043__b16415113719133">not_tags</strong>, and <strong id="sfs_02_0043__b5415437171313">not_tags_any</strong> are optional and can be combined with each other. Such tag search fields are in the AND relationship.</p>
|
|
</div></div>
|
|
</li><li id="sfs_02_0043__li177371343010">Description of the <strong id="sfs_02_0043__b205091216151911">match</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0043__table8700165114918" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0043__row18704351184920"><th align="left" class="cellrowborder" valign="top" width="17.349999999999998%" id="mcps1.3.3.2.2.2.1.5.1.1"><p id="sfs_02_0043__p189162227348">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.270000000000001%" id="mcps1.3.3.2.2.2.1.5.1.2"><p id="sfs_02_0043__p179169221348">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.39%" id="mcps1.3.3.2.2.2.1.5.1.3"><p id="sfs_02_0043__p16916162211347">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.99%" id="mcps1.3.3.2.2.2.1.5.1.4"><p id="sfs_02_0043__p1891632243416">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sfs_02_0043__row5711851104916"><td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="sfs_02_0043__p1171285194914">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.270000000000001%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="sfs_02_0043__p9713651194915">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="sfs_02_0043__p1271417518493">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="sfs_02_0043__p15715105110494">Specifies the key. The value is fixed to <strong id="sfs_02_0043__b842352706195317">resource_name</strong>. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row167164518492"><td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="sfs_02_0043__p197176519493">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.270000000000001%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="sfs_02_0043__p107191513491">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.39%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="sfs_02_0043__p572005134917">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="sfs_02_0043__p6384205191014">Specifies the value. <strong id="sfs_02_0043__b782741862114">value</strong> indicates the name of a shared file system. An empty string specifies an exact match and only shared file systems whose names are empty can be queried. A non-empty string specifies a fuzzy query (case insensitive). The value can contain a maximum of 255 characters. </p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="sfs_02_0043__li9341617307">Description of the <strong id="sfs_02_0043__b16521949172820">tag</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0043__table14385185545214" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0043__row5389135517522"><th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.3.2.3.2.1.5.1.1"><p id="sfs_02_0043__p210392663413">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.131313131313133%" id="mcps1.3.3.2.3.2.1.5.1.2"><p id="sfs_02_0043__p610320267341">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.3.2.3.2.1.5.1.3"><p id="sfs_02_0043__p181033266340">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.505050505050505%" id="mcps1.3.3.2.3.2.1.5.1.4"><p id="sfs_02_0043__p20119162643420">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sfs_02_0043__row10396165515211"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.3.2.3.2.1.5.1.1 "><p id="sfs_02_0043__p7397185512522">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.3.2.1.5.1.2 "><p id="sfs_02_0043__p19398125516523">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.3.2.1.5.1.3 "><p id="sfs_02_0043__p18399255165215">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.505050505050505%" headers="mcps1.3.3.2.3.2.1.5.1.4 "><p id="sfs_02_0043__p14400185515528">Specifies the key of the tag. A tag key can contain a maximum of 127 characters. This parameter cannot be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row144011055105210"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.3.2.3.2.1.5.1.1 "><p id="sfs_02_0043__p144021355135210">values</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.131313131313133%" headers="mcps1.3.3.2.3.2.1.5.1.2 "><p id="sfs_02_0043__p1640495512522">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.3.2.1.5.1.3 "><p id="sfs_02_0043__p8759164412113">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.505050505050505%" headers="mcps1.3.3.2.3.2.1.5.1.4 "><p id="sfs_02_0043__p240685517526">Lists the values. Each value can contain a maximum of 255 characters. If the value is left empty, any value is matched. The values are in the OR relationship. </p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="sfs_02_0043__li3973086014513">Example request<pre class="screen" id="sfs_02_0043__screen1279212312533">{
|
|
"offset": "0",
|
|
"limit": "100",
|
|
"action": "filter",
|
|
"matches": [{
|
|
"key": "resource_name",
|
|
"value": "share_name"
|
|
}],
|
|
"tags": [{
|
|
"key": "key1",
|
|
"values": ["value2"]
|
|
}, {
|
|
"key": "key2",
|
|
"values": []
|
|
}],
|
|
"tags_any": [{
|
|
"key": "key3",
|
|
"values": ["value3"]
|
|
}, {
|
|
"key": "key4",
|
|
"values": []
|
|
}],
|
|
"not_tags": [{
|
|
"key": "key5",
|
|
"values": ["value5"]
|
|
}, {
|
|
"key": "key6",
|
|
"values": []
|
|
}],
|
|
"not_tags_any": [{
|
|
"key": "key7",
|
|
"values": ["value7", "value8"]
|
|
}, {
|
|
"key": "key9",
|
|
"values": []
|
|
}]
|
|
}</pre>
|
|
</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">{
|
|
"offset": "0",
|
|
"limit": "100",
|
|
"action": "filter",
|
|
"tags": [{
|
|
"key": "key1",
|
|
"values": ["value2"]
|
|
}, {
|
|
"key": "key2",
|
|
"values": []
|
|
}]
|
|
}</pre>
|
|
</li><li id="sfs_02_0043__li39591616175614">Example request (without passing <strong id="sfs_02_0043__b855112283586">limit</strong> and <strong id="sfs_02_0043__b205511128155818">offset</strong>)<pre class="screen" id="sfs_02_0043__screen19963171620567">{
|
|
"action": "filter",
|
|
"matches": [{
|
|
"key": "resource_name",
|
|
"value": "share_name"
|
|
}],
|
|
"tags": [{
|
|
"key": "key1",
|
|
"values": ["value2"]
|
|
}, {
|
|
"key": "key2",
|
|
"values": []
|
|
}]
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="sfs_02_0043__ul75841053822"><li id="sfs_02_0043__li9586953929">Example request (without passing <strong id="sfs_02_0043__b7679635312">tags</strong>, <strong id="sfs_02_0043__b16481206438">not_tags</strong>, <strong id="sfs_02_0043__b54642111234">tags_any</strong>, and <strong id="sfs_02_0043__b1933120156310">not_tags_any</strong>)<pre class="screen" id="sfs_02_0043__screen958915320211">{
|
|
"offset": "0",
|
|
"limit": "100",
|
|
"action": "filter",
|
|
"matches": [{
|
|
"key": "resource_name",
|
|
"value": "share_name"
|
|
}]
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="sfs_02_0043__ul11114644681"><li id="sfs_02_0043__li2116134413812">Example request (with the <strong id="sfs_02_0043__b167614201414">action</strong> field only)<pre class="screen" id="sfs_02_0043__screen912310441818">{
|
|
"action": "filter"
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="sfs_02_0043__section6408307814513"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0043__ul2334684914513"><li id="sfs_02_0043__li879505414513">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0043__table146375523240" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0043__row1268155212411"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.7.2.1.1.1.4.1.1"><p id="sfs_02_0043__p13509163313410">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.7.2.1.1.1.4.1.2"><p id="sfs_02_0043__p2525163316349">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.7.2.1.1.1.4.1.3"><p id="sfs_02_0043__p95256339346">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sfs_02_0043__row4681152162413"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.1.1.1.4.1.1 "><p id="sfs_02_0043__p19681152102419">resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.1.1.1.4.1.2 "><p id="sfs_02_0043__p668112526243">Array of resources</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.7.2.1.1.1.4.1.3 "><p id="sfs_02_0043__p158814432712">Specifies the list of shared file systems that meet the query criteria.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row166826528247"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.1.1.1.4.1.1 "><p id="sfs_02_0043__p19682145262413">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.1.1.1.4.1.2 "><p id="sfs_02_0043__p9682125212417">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.7.2.1.1.1.4.1.3 "><p id="sfs_02_0043__p20741102713270">Specifies the total number of shared file systems that meet the query criteria.</p>
|
|
<div class="note" id="sfs_02_0043__note198964013326"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="sfs_02_0043__p1698944013324"><strong id="sfs_02_0043__b4652848917321">total_count</strong> specifies the total number of shared file systems that meet the query criteria, instead of the number returned after you set <strong id="sfs_02_0043__b8423527069364">offset</strong> and <strong id="sfs_02_0043__b8423527069368">limit</strong>.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="sfs_02_0043__li11315212103014">Data structure of the <strong id="sfs_02_0043__b587255134410">resource</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0043__table871281418254" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0043__row883611492519"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.7.2.2.2.1.4.1.1"><p id="sfs_02_0043__p583614403340">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.7.2.2.2.1.4.1.2"><p id="sfs_02_0043__p18527404345">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.7.2.2.2.1.4.1.3"><p id="sfs_02_0043__p185274014345">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sfs_02_0043__row8836111452512"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.2.2.1.4.1.1 "><p id="sfs_02_0043__p9836131412510">resource_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.2.2.1.4.1.2 "><p id="sfs_02_0043__p158361714142511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.7.2.2.2.1.4.1.3 "><p id="sfs_02_0043__p1383641472512">Specifies the ID of the shared file system.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row8836121472513"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.2.2.1.4.1.1 "><p id="sfs_02_0043__p08361814192510">resource_detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.2.2.1.4.1.2 "><p id="sfs_02_0043__p168365141256">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.7.2.2.2.1.4.1.3 "><p id="sfs_02_0043__p1783616142254">Specifies the resource details. The value is a resource object, used for extension. This value is left empty by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row20836614182515"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.2.2.1.4.1.1 "><p id="sfs_02_0043__p1883651492510">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.2.2.1.4.1.2 "><p id="sfs_02_0043__p8836314122515">Array of resource_tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.7.2.2.2.1.4.1.3 "><p id="sfs_02_0043__p1836131417255">Specifies the list of tags. If no tags exist, the value is an empty array by default. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row1962112717255"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.2.2.1.4.1.1 "><p id="sfs_02_0043__p4621107162513">sys_tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.2.2.1.4.1.2 "><p id="sfs_02_0043__p462120752515">Array of tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.7.2.2.2.1.4.1.3 "><p id="sfs_02_0043__p678712042612">Only the op_service permission can obtain this field.</p>
|
|
<ol id="sfs_02_0043__ol2078702010263"><li id="sfs_02_0043__li978713202266">Currently, only one tag structure key is used, <strong id="sfs_02_0043__b175413154417">_sys_enterprise_project_id</strong>.</li><li id="sfs_02_0043__li5787220192610">Currently, <strong id="sfs_02_0043__b59619143448">key</strong> contains only one value.</li></ol>
|
|
<p id="sfs_02_0043__p1878752022615">This field cannot be returned in non-op_service scenarios.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row128361914162515"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.2.2.1.4.1.1 "><p id="sfs_02_0043__p88361514202515">resource_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.2.2.1.4.1.2 "><p id="sfs_02_0043__p8837141442520">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.7.2.2.2.1.4.1.3 "><p id="sfs_02_0043__p17837014142513">Specifies the resource name. </p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="sfs_02_0043__li1223711164301">Data structure of the <strong id="sfs_02_0043__b579515375449">resource_tag</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0043__table18728414112510" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0043__row5838171442511"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.7.2.3.2.1.4.1.1"><p id="sfs_02_0043__p941375293419">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.7.2.3.2.1.4.1.2"><p id="sfs_02_0043__p1541385263417">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.7.2.3.2.1.4.1.3"><p id="sfs_02_0043__p9413135218349">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sfs_02_0043__row178381314142517"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.3.2.1.4.1.1 "><p id="sfs_02_0043__p168381714142520">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.3.2.1.4.1.2 "><p id="sfs_02_0043__p083841419254">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.7.2.3.2.1.4.1.3 "><p id="sfs_02_0043__p1883818148258">Specifies the tag key. The value can contain a maximum of 36 characters. This parameter cannot be left blank. It can only contain letters, digits, hyphens (-), and underscores (_).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row3838171492513"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.3.2.1.4.1.1 "><p id="sfs_02_0043__p48381714182519">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.7.2.3.2.1.4.1.2 "><p id="sfs_02_0043__p583801412259">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.7.2.3.2.1.4.1.3 "><p id="sfs_02_0043__p1083891414254">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></ul>
|
|
<ul id="sfs_02_0043__ul3903357014513"><li id="sfs_02_0043__li1575781314513">Example response<pre class="screen" id="sfs_02_0043__screen1132815652010">{
|
|
"resources":[
|
|
{
|
|
"resource_detail":{},
|
|
"resource_id":"b1f3f06f-344d-446b-a4bf-647a225debae",
|
|
"resource_name":"share_name",
|
|
"tags":[
|
|
{
|
|
"key":"key1",
|
|
"value": "value1"
|
|
},
|
|
{
|
|
"key":"key2",
|
|
"value": "value2"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"total_count":1
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sfs_02_0043__section4959408514513"><h4 class="sectiontitle">Status Codes</h4><ul id="sfs_02_0043__ul5769798014513"><li id="sfs_02_0043__li4951977214513">Normal<p id="sfs_02_0043__p4302476614513"><a name="sfs_02_0043__li4951977214513"></a><a name="li4951977214513"></a>200</p>
|
|
</li><li id="sfs_02_0043__li5167858014513">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0043__table6245403714513" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0043__row1507735814513"><th align="left" class="cellrowborder" valign="top" width="43.43%" id="mcps1.3.8.2.2.1.1.3.1.1"><p id="sfs_02_0043__p1330652014513">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.8.2.2.1.1.3.1.2"><p id="sfs_02_0043__p408636314513">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sfs_02_0043__row3477393214513"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.8.2.2.1.1.3.1.1 "><p id="sfs_02_0043__p6522508214513">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.8.2.2.1.1.3.1.2 "><p id="sfs_02_0043__p4874025614513">Invalid value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row3600912414513"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.8.2.2.1.1.3.1.1 "><p id="sfs_02_0043__p3105792214513">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.8.2.2.1.1.3.1.2 "><p id="sfs_02_0043__p3266375714513">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row2553835814513"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.8.2.2.1.1.3.1.1 "><p id="sfs_02_0043__p5534113514513">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.8.2.2.1.1.3.1.2 "><p id="sfs_02_0043__p5344692014513">Access to the requested page is forbidden.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row1126023214513"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.8.2.2.1.1.3.1.1 "><p id="sfs_02_0043__p3966357214513">404 Not Found</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.8.2.2.1.1.3.1.2 "><p id="sfs_02_0043__p5863278914513">The requested resource was not found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0043__row1011562214513"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.8.2.2.1.1.3.1.1 "><p id="sfs_02_0043__p1405905414513">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.8.2.2.1.1.3.1.2 "><p id="sfs_02_0043__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>
|
|
|