yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
26dfc1fff2dd6735fb9ace16a3a59edecfd9873c
doc-exports/docs/sfs/api-ref/ListShares.html
zhangyue e0d0a83c1f SFS API DOC 
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2025-04-14 12:20:07 +00:00

492 lines
35 KiB
HTML
Raw Blame History

<a name="ListShares"></a><a name="ListShares"></a>
<h1 class="topictitle1">Obtaining the File System List</h1>
<div id="body1708331107508"><div class="section" id="ListShares__section233933312429"><h4 class="sectiontitle">Function</h4><p id="ListShares__p13391433164212">This API is used to obtain the file system list.</p>
</div>
<div class="section" id="ListShares__section5339153394214"><h4 class="sectiontitle">URI</h4><p id="ListShares__p1233933394210">GET /v1/{project_id}/sfs-turbo/shares/detail</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListShares__table63404332422" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListShares__row33391133154216"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListShares__p1234033324220">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListShares__p634020332427">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListShares__p83401933194217">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListShares__p934013315423">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row1233963324217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListShares__p133401733134213">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListShares__p6340143315424">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListShares__p734023314212">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListShares__p153401733144210">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListShares__table534133394218" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListShares__row3341163310423"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListShares__p15341163394218">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListShares__p33411533144218">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListShares__p183411833114215">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListShares__p53412333424">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row634123324218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListShares__p1341153311428">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListShares__p1734112334421">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListShares__p53411033104213">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListShares__p034243394214">Specifies the maximum number of returned file systems. If this parameter is not specified, the default value 1000 is used.</p>
</td>
</tr>
<tr id="ListShares__row1834193384220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListShares__p134243314427">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListShares__p834233319421">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListShares__p15342133311423">Long</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListShares__p18342133314424">Sets the offset of the returned file system.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListShares__section13422033204216"><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__row1342163317421"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListShares__p234393311423">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListShares__p12343203354220">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListShares__p19343833134213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListShares__p534311331423">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row133421733134212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListShares__p143431933134212">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListShares__p10343633154217">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListShares__p163431333114215">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListShares__p11343123304212">Account token</p>
</td>
</tr>
<tr id="ListShares__row16342433124211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListShares__p11343333154218">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListShares__p1034333364216">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListShares__p234420332427">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListShares__p234413330426">MIME type</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListShares__section113442033164219"><h4 class="sectiontitle">Response Parameters</h4><p id="ListShares__p53441331424"><strong id="ListShares__b1434433317425">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__row1034423314215"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ListShares__p1334423315424">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ListShares__p234423394218">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ListShares__p1734523314424">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row7344183314212"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListShares__p6345933124210">shares</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListShares__p23454339422">Array of <a href="#ListShares__response_ShareInfo">ShareInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListShares__p1634563315421">List of SFS Turbo file systems</p>
</td>
</tr>
<tr id="ListShares__row1834483319428"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListShares__p9345123311423">count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListShares__p3345183311425">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListShares__p2034516333426">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__row183463339422"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ListShares__p133471633104218">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ListShares__p203473333424">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ListShares__p1734743320425">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row173467331428"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p234723317429">action_progress</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p11347173384218"><a href="#ListShares__response_ActionProgress">ActionProgress</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1434733334211">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__row034617333426"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p8347633184216">version</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p183471133134210">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p534803316429">Version of the SFS Turbo file system</p>
</td>
</tr>
<tr id="ListShares__row43469339423"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p1534813374210">avail_capacity</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p23481533124220">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1334818337422">Available capacity of the SFS Turbo file system, in GB</p>
</td>
</tr>
<tr id="ListShares__row1834619335428"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p143481733174216">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p11348833114216">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p3348153316425">Code of the AZ where the SFS Turbo file system resides</p>
</td>
</tr>
<tr id="ListShares__row2346193324218"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p3348163364212">az_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p133481833154213">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p163485336420">Name of the AZ where the SFS Turbo file system resides</p>
</td>
</tr>
<tr id="ListShares__row9346133124215"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p1334833364219">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p5348133154211">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p7348733124211">Time when the file system was created. UTC time, for example: 2018-11-19T04:02:03</p>
</td>
</tr>
<tr id="ListShares__row7346133164212"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p1734912339423">crypt_key_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p634910333426">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p134919338423">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__row83461233154218"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p334943318425">expand_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p1234903334219">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" 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__row534663318425"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p43492336427">export_location</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p12349183311429">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p43491333429">Location where the SFS Turbo file system is mounted For example, 192.168.0.90:/. If the file system is being created, this parameter is not returned.</p>
</td>
</tr>
<tr id="ListShares__row634610339429"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p8349143310428">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p123494333429">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p113491333144212">ID of the SFS Turbo file system</p>
</td>
</tr>
<tr id="ListShares__row143461333428"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p153491533154213">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p735010334428">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p33501233154218">Name of the SFS Turbo file system specified during creation</p>
</td>
</tr>
<tr id="ListShares__row12346113324212"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p3350193324219">pay_model</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p63501033104210">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p135083344216">Billing mode of the SFS Turbo file system. '0' indicates pay-per-use. If the file system is being created, this parameter is not returned.</p>
</td>
</tr>
<tr id="ListShares__row83461233124214"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p11350123320429">region</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p1235017335423">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p23504333427">Region where the SFS Turbo file system resides</p>
</td>
</tr>
<tr id="ListShares__row1734603314429"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p1335033320428">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p13350133324217">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p635013334210">ID of the security group specified by the user</p>
</td>
</tr>
<tr id="ListShares__row18346143311423"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p19350933164217">share_proto</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p335093364211">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p935163344216">Protocol used by the SFS Turbo file system. The valid value is <strong id="ListShares__b3351133312429">NFS</strong>.</p>
</td>
</tr>
<tr id="ListShares__row2346173334212"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p2351153344214">share_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p18351733104218">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1735143318420">Storage class of the SFS Turbo file system. Valid values are <strong id="ListShares__b7351833134214">STANDARD</strong> and <strong id="ListShares__b23519338426">PERFORMANCE</strong>.</p>
</td>
</tr>
<tr id="ListShares__row1234610331420"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p5351163344218">size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p1335183310427">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1635153314211">Total capacity of the SFS Turbo file system, in GB</p>
</td>
</tr>
<tr id="ListShares__row9346123394211"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p435183315422">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p7351113304213">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p23511933104220">SFS Turbo file system status. The value can be as follows: <strong id="ListShares__b1351103394219">100</strong> (creating), <strong id="ListShares__b16351633174217">200</strong> (available), <strong id="ListShares__b10351173319428">303</strong> (creation failed), and <strong id="ListShares__b0351103394219">800</strong> (frozen)</p>
</td>
</tr>
<tr id="ListShares__row1346833154213"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p17351123311424">sub_status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p1435213313426">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" 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__row534633315425"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p3352153313423">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p135293315429">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1835213374211">ID of the subnet specified by the user</p>
</td>
</tr>
<tr id="ListShares__row1634673314211"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p535223312420">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p16352733114212">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p19352633144218">ID of the VPC specified by the user</p>
</td>
</tr>
<tr id="ListShares__row1134683334212"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p1935303374214">tags</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p73531933154210">Array of <a href="#ListShares__response_ResourceTag">ResourceTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p63531633164218">Tag list</p>
</td>
</tr>
<tr id="ListShares__row11346143311421"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p935313332421">optional_endpoint</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p3353153354210">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p935343394215">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__row1934619338423"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p4353203316421">hpc_bw</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p183531833174217">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p20353103313426">File system bandwidth.</p>
<ul id="ListShares__ul33538331424"><li id="ListShares__li11353173374219">"20M": 20 MB/s/TiB</li><li id="ListShares__li1835317332424">"40M": 40 MB/s/TiB</li><li id="ListShares__li6353133394215">"125M": 125 MB/s/TiB</li><li id="ListShares__li183533334429">"250M": 250 MB/s/TiB<p id="ListShares__p12354133164219"><a name="ListShares__li183533334429"></a><a name="li183533334429"></a></p>
<p id="ListShares__p10354113311429"></p>
<p id="ListShares__p183547336429"></p>
</li></ul>
</td>
</tr>
<tr id="ListShares__row1234616333427"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p435493334210">instanceId</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p12354633124219">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p173541733134219">Node ID of the file system type. This is a reserved field.</p>
</td>
</tr>
<tr id="ListShares__row17346203312424"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p16354933164213">instanceType</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p63541335423">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1535410334428">Node type of the file system type. This is a reserved field.</p>
</td>
</tr>
<tr id="ListShares__row10346733174219"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p113541331423">statusDetail</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p43548339421">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p153541533104218">Request ID of the file system. This is a reserved field.</p>
</td>
</tr>
<tr id="ListShares__row1347163384210"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListShares__p1735433317423">features</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListShares__p8355103364219"><a href="#ListShares__response_ShareInfoFeatures">ShareInfoFeatures</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListShares__p1935517338425">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__row16355133104220"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ListShares__p935553354212">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ListShares__p23551533194219">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ListShares__p143551733124217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row1135513332428"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListShares__p8355203317420">CREATING</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListShares__p13355533174210">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListShares__p11356113313427">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__row8356103314420"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ListShares__p163561333164219">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ListShares__p3356193315423">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ListShares__p035613335422">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row135693317427"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListShares__p1335614337423">key</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListShares__p18356933114211">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListShares__p19356113312429">Tag key.</p>
<p id="ListShares__p1435783311423">It can contain a maximum of 128 characters.</p>
<p id="ListShares__p173572331427">It cannot be left empty and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (&lt;), right angle brackets (&gt;), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="ListShares__row19356733124220"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListShares__p1635793304218">value</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListShares__p1357193316429">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListShares__p14357933164211">Tag value.</p>
<p id="ListShares__p183571133114214">Each tag value can contain a maximum of 255 characters and can be an empty string.</p>
<p id="ListShares__p1835793394210">It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (&lt;), right angle brackets (&gt;), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListShares__response_ShareInfoFeatures"></a><a name="response_ShareInfoFeatures"></a><table cellpadding="4" cellspacing="0" summary="" id="ListShares__response_ShareInfoFeatures" frame="border" border="1" rules="all"><caption><b>Table 8 </b>ShareInfoFeatures</caption><thead align="left"><tr id="ListShares__row135713315422"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="ListShares__p3358633174217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="ListShares__p1635863310421">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="ListShares__p1235853324217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row83571339427"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListShares__p735843344214">backup</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListShares__p2358163334212"><a href="#ListShares__response_ShareInfoFeature">ShareInfoFeature</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListShares__p19358833124212">Whether the SFS Turbo file system supports backup.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListShares__response_ShareInfoFeature"></a><a name="response_ShareInfoFeature"></a><table cellpadding="4" cellspacing="0" summary="" id="ListShares__response_ShareInfoFeature" frame="border" border="1" rules="all"><caption><b>Table 9 </b>ShareInfoFeature</caption><thead align="left"><tr id="ListShares__row183581333164211"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="ListShares__p1335918333426">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="ListShares__p535993320428">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="ListShares__p435923354217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row9358833144216"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListShares__p3359163315428">is_support</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListShares__p33591633164211">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListShares__p83591933164210">Whether the file system supports this feature.</p>
</td>
</tr>
<tr id="ListShares__row1635803354213"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListShares__p1135916333428">message</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListShares__p16359163314216">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListShares__p9503113313427">Message about whether the file system supports this feature.</p>
</td>
</tr>
<tr id="ListShares__row1135893314214"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListShares__p05031833104217">msg_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListShares__p13503113384218">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListShares__p550319337422">Code of the message about whether the file system supports this feature.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListShares__section850320331421"><h4 class="sectiontitle">Example Requests</h4><p id="ListShares__p95036337428">Querying file systems in the project whose ID <strong id="ListShares__b3503133174210">e1e45b08f3ea4480ab4655ef9c7160ba</strong></p>
<pre class="screen" id="ListShares__screen195031733144220">GET HTTPS://{endpoint}/v1/e1e45b08f3ea4480ab4655ef9c7160ba/sfs-turbo/shares/detail</pre>
</div>
<div class="section" id="ListShares__section145032330423"><h4 class="sectiontitle">Example Responses</h4><p id="ListShares__p1450383384214"><strong id="ListShares__b950383314426">Status code: 200</strong></p>
<div class="p" id="ListShares__p750383310421">Response body for querying the file system list<pre class="screen" id="ListShares__screen750483374218">{
"shares" : [ {
"id" : "8fba8253-c914-439d-ae8b-d5c89d0bf5e8",
"name" : "sfs-turbo-8468",
"status" : "100",
"version" : "1.0.0",
"region" : "example",
"created_at" : "2018-11-19T04:02:03",
"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"
} ]
}</pre>
</div>
</div>
<div class="section" id="ListShares__section19505133313422"><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__row16364143394220"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListShares__p19505133315424">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__p95051733194213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListShares__row33641933114218"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListShares__p250543317428">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListShares__p550513313426">Response body for querying the file system list</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListShares__section1750510335421"><h4 class="sectiontitle">Error Codes</h4><p id="ListShares__p150513337427">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