vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/sfs/api-ref/ListShares.html
zhangyue 49ac6fa9ce SFS HPC API DOC 
Reviewed-by: Miskanin, Jan <jan.miskanin@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-08-16 12:25:57 +00:00

465 lines
33 KiB
HTML
Raw Blame History

<a name="ListShares"></a><a name="ListShares"></a>
<h1 class="topictitle1">Obtaining the File System List</h1>
<div id="body9426130163413"><div class="section" id="ListShares__section542670133416"><h4 class="sectiontitle">Function</h4><p id="ListShares__p124268016345">This API is used to obtain the file system list.</p>
</div>
<div class="section" id="ListShares__section134264053410"><h4 class="sectiontitle">URI</h4><p id="ListShares__p114261105349">GET /v1/{project_id}/sfs-turbo/shares/detail</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListShares__table1742790203418" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListShares__row6427100153419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListShares__p154271902340">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListShares__p14428140103411">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListShares__p542810053410">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListShares__p1442813010340">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row1242712033417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListShares__p13428170143418">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListShares__p1542817053417">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListShares__p94282033420">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListShares__p34291801342">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListShares__table34291401343" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListShares__row174291607347"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListShares__p542940193411">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListShares__p19429306341">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListShares__p743050173419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListShares__p154308083411">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row13429180123417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListShares__p1543017093410">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListShares__p124303012343">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListShares__p194308014341">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListShares__p3954165312213">Maximum number of the file systems returned is 200. If not specified, 1000 is used by default.</p>
</td>
</tr>
<tr id="ListShares__row44298093417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListShares__p1543113053419">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListShares__p7431180203419">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListShares__p34312053417">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListShares__p1043130173410">Offset where the file system listing starts.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListShares__section94328063419"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListShares__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListShares__row1643260163412"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListShares__p124338018340">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListShares__p1643360113417">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListShares__p19433108345">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListShares__p34334010344">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row44324017344"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListShares__p2433120123410">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListShares__p5433120103414">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListShares__p443460153417">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListShares__p2434160183419">Account token</p>
</td>
</tr>
<tr id="ListShares__row843213073413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListShares__p1943480183416">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListShares__p12434709345">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListShares__p1143419015348">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListShares__p54351106343">MIME type</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListShares__section1443519017343"><h4 class="sectiontitle">Response Parameters</h4><p id="ListShares__p174351603347"><strong id="ListShares__b6435140203410">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListShares__response_ListSharesResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListShares__row5435606349"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListShares__p5436300347">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListShares__p14368063419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListShares__p114366010345">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row043516003410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListShares__p543611083419">shares</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListShares__p184376053411">Array of <a href="#ListShares__response_ShareInfo">ShareInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListShares__p1843710123417">List of SFS Turbo file systems</p>
</td>
</tr>
<tr id="ListShares__row74351083415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListShares__p643710018346">count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListShares__p1343716015343">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListShares__p3437200103413">Number of SFS Turbo file systems</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListShares__response_ShareInfo"></a><a name="response_ShareInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListShares__response_ShareInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ShareInfo</caption><thead align="left"><tr id="ListShares__row1143850203412"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListShares__p644013012341">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListShares__p344018018347">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListShares__p154401808341">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row13438120193416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p2044014019346">action_progress</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p144415043410"><a href="#ListShares__response_ActionProgress">ActionProgress</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p844115019349">Creation progress of the SFS Turbo file system. This field is only returned when the file system is being created.</p>
</td>
</tr>
<tr id="ListShares__row543820013342"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p444160143410">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p944111073413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p8441130193418">Version of the SFS Turbo file system</p>
</td>
</tr>
<tr id="ListShares__row1043819083415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p12441180103414">avail_capacity</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p1044220018341">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p0442140143414">Available capacity of the SFS Turbo file system, in GB</p>
</td>
</tr>
<tr id="ListShares__row343813023416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p444218014347">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p1244214073419">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p144212013415">Code of the AZ where the SFS Turbo file system resides</p>
</td>
</tr>
<tr id="ListShares__row44383023412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p13442190173414">az_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p1944314016343">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p74430015348">Name of the AZ where the SFS Turbo file system resides</p>
</td>
</tr>
<tr id="ListShares__row0438907344"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p13443306348">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p24431503346">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p174431023410">Time when the file system was created. UTC time, for example: 2018-11-19T04:02:03</p>
</td>
</tr>
<tr id="ListShares__row44386013346"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p24431802343">crypt_key_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p244412011344">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1544418014343">ID of the encryption key specified by the user. This parameter is not returned for non-encrypted file systems.</p>
</td>
</tr>
<tr id="ListShares__row1443815023417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p174442018349">expand_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p744415043411">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p19444306346">For an Enhanced file system, <strong id="ListShares__b8444160183420">bandwidth</strong> is returned. For a 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system, <strong id="ListShares__b1644415083412">hpc</strong> is returned. For other types of file systems, this field is not returned.</p>
</td>
</tr>
<tr id="ListShares__row1743820173419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p9445401344">export_location</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p844560113410">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p114451020344">Location of the SFS Turbo file system. For a previous-generation file system, an IP address is returned, for example, <strong id="ListShares__b104451902345">192.168.0.90:/</strong>. For a 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system, a domain name is returned, for example, <strong id="ListShares__b944570113413">2c568e3b-da13-4041-b5f8-fb77f611914e.sfsturbo.internal:/</strong>. If the file system is being created, this field is not returned.</p>
</td>
</tr>
<tr id="ListShares__row15439909345"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p134451308345">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p1445205342">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p104458013413">ID of the SFS Turbo file system</p>
</td>
</tr>
<tr id="ListShares__row84396015348"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p1944518016347">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p94465013420">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p84463012345">Name of the SFS Turbo file system specified during creation</p>
</td>
</tr>
<tr id="ListShares__row17439309348"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p34461010346">pay_model</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p2446130123411">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1446107342">Billing mode of the SFS Turbo file system. Value <strong id="ListShares__b18446500343">0</strong> indicates pay-per-use. If the file system is being created, this field is not returned.</p>
<p id="ListShares__p18446706344">Enumeration values:</p>
<ul id="ListShares__ul04467016341"><li id="ListShares__li8446804345"><strong id="ListShares__b5447108343">0</strong></li><li id="ListShares__li14447110133414"><strong id="ListShares__b114471709346">1</strong></li></ul>
</td>
</tr>
<tr id="ListShares__row15439190193415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p544719073413">region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p20447150193414">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1244714043414">Region where the SFS Turbo file system resides</p>
</td>
</tr>
<tr id="ListShares__row174392053410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p94479014345">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p1344880153413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p114483033414">ID of the security group specified by the user</p>
</td>
</tr>
<tr id="ListShares__row1543920003415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p84489015344">share_proto</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p154480063413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p194486010341">Protocol used by the SFS Turbo file system. The valid value is <strong id="ListShares__b1744816013342">NFS</strong>.</p>
</td>
</tr>
<tr id="ListShares__row194391608340"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p34481108344">share_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p64492018344">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p8449705348">Storage class of the SFS Turbo file system. Valid values are <strong id="ListShares__b844911023412">STANDARD</strong> and <strong id="ListShares__b164494019346">PERFORMANCE</strong>.</p>
</td>
</tr>
<tr id="ListShares__row2043912003420"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p1944915073419">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p6449130143410">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1044930143417">Total capacity of the SFS Turbo file system, in GB</p>
</td>
</tr>
<tr id="ListShares__row94399014342"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p344916063410">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p134501043414">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1345011015344">SFS Turbo file system status. The value can be as follows: <strong id="ListShares__b94508015347">100</strong> (creating), <strong id="ListShares__b17450403349">200</strong> (available), <strong id="ListShares__b54502083412">303</strong> (creation failed), and <strong id="ListShares__b1945030163419">800</strong> (frozen)</p>
</td>
</tr>
<tr id="ListShares__row1243915010349"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p94501706344">sub_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p11450606345">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p15450409348">Sub-status of the SFS Turbo file system. The value can be as follows: This field is not returned if no modification is made to the file system. <strong id="ListShares__b245070133414">121</strong> (expanding capacity), <strong id="ListShares__b1745040183410">132</strong> (changing security group), <strong id="ListShares__b545030163416">137</strong> (adding authorized VPC), <strong id="ListShares__b1245012013414">138</strong> (removing authorized VPC) <strong id="ListShares__b345010019349">221</strong> (expansion succeeded), <strong id="ListShares__b6450200153418">232</strong> (security group changed), <strong id="ListShares__b6450140113415">237</strong> (authorized VPC added), <strong id="ListShares__b134501702343">238</strong> (authorized VPC removed) <strong id="ListShares__b1245014033416">321</strong> (expansion failed), <strong id="ListShares__b0450609343">332</strong> (changing security group failed), <strong id="ListShares__b174502043415">337</strong> (adding authorized VPC failed), <strong id="ListShares__b1945010193419">338</strong> (removing authorized VPC failed)</p>
</td>
</tr>
<tr id="ListShares__row543950133417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p14451180153412">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p134510023413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p11451100163411">ID of the subnet specified by the user</p>
</td>
</tr>
<tr id="ListShares__row343919003415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p14451607342">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p24511506347">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1945113015344">ID of the VPC specified by the user</p>
</td>
</tr>
<tr id="ListShares__row34391017343"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p11452140193419">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p245216053417">Array of <a href="#ListShares__response_ResourceTag">ResourceTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p11453110113415">Tag list</p>
</td>
</tr>
<tr id="ListShares__row1043911015348"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p12453120183410">optional_endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p945312018343">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p18453100153418">Alternative IP addresses that can be used for mounting. This field is not returned for previous-generation file systems.</p>
</td>
</tr>
<tr id="ListShares__row19439140103418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p1945311033411">hpc_bw</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p2045315073420">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p045319013344">File system bandwidth.</p>
<ul id="ListShares__ul645417003411"><li id="ListShares__li1445412019342">"20M": 20 MB/s/TiB</li><li id="ListShares__li8454180183417">"40M": 40 MB/s/TiB</li><li id="ListShares__li1145420183414">"125M": 125 MB/s/TiB</li><li id="ListShares__li1645417033419">"250M": 250 MB/s/TiB</li></ul>
</td>
</tr>
<tr id="ListShares__row143918013416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p345414093419">instanceId</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p245416012348">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p545430133420">Node ID of the file system type. This is a reserved field.</p>
</td>
</tr>
<tr id="ListShares__row144395015346"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p1645511012347">instanceType</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p1645590113416">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p2045516053412">Node type of the file system type. This is a reserved field.</p>
</td>
</tr>
<tr id="ListShares__row17439160143416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p5455130183411">statusDetail</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p13455180133410">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p94555011342">Request ID of the file system. This is a reserved field.</p>
</td>
</tr>
<tr id="ListShares__row1243914003411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p144550019349">features</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p245610083417">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1345613017349">Whether backup is supported for SFS turbo file systems.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListShares__response_ActionProgress"></a><a name="response_ActionProgress"></a><table cellpadding="4" cellspacing="0" summary="" id="ListShares__response_ActionProgress" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ActionProgress</caption><thead align="left"><tr id="ListShares__row545650153416"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListShares__p144571308349">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListShares__p19457110153410">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListShares__p14571604349">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row8456120183415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListShares__p154571804342">CREATING</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListShares__p1845810023413">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListShares__p1545860143416">File system creation progress</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListShares__response_ResourceTag"></a><a name="response_ResourceTag"></a><table cellpadding="4" cellspacing="0" summary="" id="ListShares__response_ResourceTag" frame="border" border="1" rules="all"><caption><b>Table 7 </b>ResourceTag</caption><thead align="left"><tr id="ListShares__row045817015345"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ListShares__p4459708342">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ListShares__p545918014345">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ListShares__p04591013417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row645880133411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListShares__p24591209346">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListShares__p1845918053419">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListShares__p9459190183414">Tag key.</p>
<p id="ListShares__p11459308343">It can contain a maximum of 128 characters.</p>
<p id="ListShares__p124601304348">It cannot be left empty and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (&lt;), right angle brackets (&gt;), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).</p>
<p id="ListShares__p4460110173417">Minimum: <strong id="ListShares__b34607003412">1</strong></p>
<p id="ListShares__p104604023419">Maximum: <strong id="ListShares__b346010023417">128</strong></p>
</td>
</tr>
<tr id="ListShares__row1845850153416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListShares__p104609019342">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListShares__p11460100123416">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListShares__p24602013417">Tag value.</p>
<p id="ListShares__p19460120113419">Each tag value can contain a maximum of 255 characters and can be an empty string.</p>
<p id="ListShares__p19460190183414">It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (&lt;), right angle brackets (&gt;), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).</p>
<p id="ListShares__p34611501348">Minimum: <strong id="ListShares__b54611602342">0</strong></p>
<p id="ListShares__p1246120053413">Maximum: <strong id="ListShares__b18461208348">255</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListShares__section44618017346"><h4 class="sectiontitle">Example Requests</h4><p id="ListShares__p346119015340">Querying file systems in the project whose ID <strong id="ListShares__b1146114011345">e1e45b08f3ea4480ab4655ef9c7160ba</strong></p>
<pre class="screen" id="ListShares__screen84614011344">GET HTTPS://{endpoint}/v1/e1e45b08f3ea4480ab4655ef9c7160ba/sfs-turbo/shares/detail</pre>
</div>
<div class="section" id="ListShares__section1046117013348"><h4 class="sectiontitle">Example Responses</h4><p id="ListShares__p18462808348"><strong id="ListShares__b204622053411">Status code: 200</strong></p>
<p id="ListShares__p1746211014345">Response body for querying the file system list</p>
<pre class="screen" id="ListShares__screen24621605345">{
"shares" : [ {
"id" : "8fba8253-c914-439d-ae8b-d5c89d0bf5e8",
"name" : "sfs-turbo-8468",
"status" : "100",
"version" : "1.0.0",
"region" : "north-1",
"created_at" : "2018-11-19T04:02:03",
"export_location" : "192.168.0.90:/",
"action_progress" : {
"CREATING" : "22%"
},
"share_type" : "STANDARD",
"sub_status" : "",
"availability_zone" : "az1.dc1",
"az_name" : "az1",
"vpc_id" : "b24e39e1-bc0c-475b-ae0c-aef9cf240af3",
"subnet_id" : "86fc01ea-8ec8-409d-ba7a-e0ea16d4fd97",
"security_group_id" : "50586458-aec9-442c-bb13-e08ddc6f1b7a",
"size" : "500.00",
"pay_model" : "0",
"avail_capacity" : "500.00",
"share_proto" : "NFS"
}, {
"id" : "65f2d30b-7b4e-4786-9608-4324faef6646",
"name" : "sfs-turbo-df12",
"status" : "200",
"version" : "1.0.0",
"region" : "north-1",
"created_at" : "2018-11-15T02:32:10",
"export_location" : "65f2d30b-7b4e-4786-9608-4324faef6646.sfsturbo.internal:/",
"optional_endpoint" : "192.168.0.90 192.168.0.89",
"share_type" : "HPC_PERFORMANCE_250M",
"expand_type" : "hpc",
"sub_status" : "",
"availability_zone" : "az1.dc1",
"az_name" : "az1",
"vpc_id" : "b24e39e1-bc0c-475b-ae0c-aef9cf240af3",
"subnet_id" : "86fc01ea-8ec8-409d-ba7a-e0ea16d4fd97",
"security_group_id" : "50586458-aec9-442c-bb13-e08ddc6f1b7a",
"size" : "3686.00",
"pay_model" : "0",
"avail_capacity" : "3686.00",
"share_proto" : "NFS"
} ]
}</pre>
</div>
<div class="section" id="ListShares__section67904011344"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListShares__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListShares__row184666017348"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListShares__p12790403345">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListShares__p137901109345">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row34666018342"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListShares__p179011019345">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListShares__p1679020123411">Response body for querying the file system list</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListShares__section147901503345"><h4 class="sectiontitle">Error Codes</h4><p id="ListShares__p19790302346">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000000.html">Lifecycle Management</a></div>
</div>
</div>
View Git Blame Copy Permalink