vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/sfs/api-ref/ExpandShare.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

194 lines
14 KiB
HTML
Raw Blame History

<a name="ExpandShare"></a><a name="ExpandShare"></a>
<h1 class="topictitle1">Expanding the Capacity of a File System</h1>
<div id="body1636232765712"><div class="section" id="ExpandShare__section143622027145716"><h4 class="sectiontitle">Function</h4><p id="ExpandShare__p19362327175719">This API is used to expand the capacity of a file system.</p>
</div>
<div class="section" id="ExpandShare__section43621027195712"><h4 class="sectiontitle">URI</h4><p id="ExpandShare__p15362192765719">POST /v1/{project_id}/sfs-turbo/shares/{share_id}/action</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExpandShare__table193639274572" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ExpandShare__row1036232719574"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ExpandShare__p12363627105714">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ExpandShare__p16363192775710">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ExpandShare__p8363202795716">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ExpandShare__p133631427125714">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExpandShare__row5362182718578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ExpandShare__p13631275572">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ExpandShare__p436452718574">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ExpandShare__p6364527105715">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ExpandShare__p436413273571">Project ID</p>
</td>
</tr>
<tr id="ExpandShare__row9362132710571"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ExpandShare__p19364527135712">share_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ExpandShare__p19364102714574">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ExpandShare__p53641827105711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ExpandShare__p9364127125718">File system ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ExpandShare__section736432710573"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExpandShare__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ExpandShare__row2036572705718"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ExpandShare__p13651127115719">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ExpandShare__p936552715572">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ExpandShare__p936542711572">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ExpandShare__p23661327125718">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExpandShare__row1436552715577"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ExpandShare__p11366327145711">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ExpandShare__p13667279573">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ExpandShare__p13366182718570">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ExpandShare__p4366102715718">Account token</p>
</td>
</tr>
<tr id="ExpandShare__row4365152719571"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ExpandShare__p10366102712576">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ExpandShare__p1736602710576">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ExpandShare__p73661827165719">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ExpandShare__p536732719574">MIME type</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExpandShare__request_ExpandShareRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="ExpandShare__row336752745713"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="ExpandShare__p193678275572">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="ExpandShare__p153671827125719">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="ExpandShare__p33679270571">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="ExpandShare__p436815274578">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExpandShare__row10367112755711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="ExpandShare__p036812715576">extend</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="ExpandShare__p136842705714">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="ExpandShare__p1136802795714"><a href="#ExpandShare__request_Extend">Extend</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="ExpandShare__p11368192725712">Object of <strong id="ExpandShare__b12368162719576">extend</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ExpandShare__request_Extend"></a><a name="request_Extend"></a><table cellpadding="4" cellspacing="0" summary="" id="ExpandShare__request_Extend" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Extend</caption><thead align="left"><tr id="ExpandShare__row83681927105716"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="ExpandShare__p7369112745710">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="ExpandShare__p636912713573">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="ExpandShare__p17369827155714">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="ExpandShare__p12369182712575">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExpandShare__row1636992719574"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="ExpandShare__p12369132711579">new_size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="ExpandShare__p5370122712573">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="ExpandShare__p137016274572">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="ExpandShare__p1537042765720">New capacity of the file system, in GiB</p>
<p id="ExpandShare__p8370112735710">For a previous-generation Standard or Performance file system, the capacity ranges from <strong id="ExpandShare__b173705275579">500</strong> to <strong id="ExpandShare__b1037082795718">32768</strong> (in GiB), and the expansion increment is 100 GiB.</p>
<p id="ExpandShare__p1537082719572">For a previous-generation Standard - Enhanced or Performance Enhanced file system, the capacity ranges from <strong id="ExpandShare__b43706275575">10240</strong> to <strong id="ExpandShare__b337012715578">327680</strong> (in GiB), and the expansion increment is 100 GiB.</p>
<p id="ExpandShare__p83701278573">For a 20 MB/s/TiB file system, the capacity ranges from <strong id="ExpandShare__b8370202725710">3686</strong> to <strong id="ExpandShare__b153704274571">1048576</strong> (in GiB) and must be a multiple of 1.2 TiB. The desired capacity must be converted to GiB and rounded down to the nearest integer. For example, use 4915 GiB for a 4.8 TiB file system and 8601 GiB for a 8.4 TiB file system. The expansion increment is 1.2 TiB.</p>
<p id="ExpandShare__p5371202710572">For a 40 MB/s/TiB file system, the capacity ranges from <strong id="ExpandShare__b53711327125714">1228</strong> to <strong id="ExpandShare__b63711727155718">1048576</strong> (in GiB) and must be a multiple of 1.2 TiB. The desired capacity must be converted to GiB and rounded down to the nearest integer. For example, use 4915 GiB for a 4.8 TiB file system and 8601 GiB for a 8.4 TiB file system. The expansion increment is 1.2 TiB.</p>
<p id="ExpandShare__p037132795717">The capacity range and expansion increment of 250 MB/s/TiB and 125 MB/s/TiB file systems are the same as those of 40 MB/s/TiB file systems.</p>
<p id="ExpandShare__p1371182719570"></p>
<p id="ExpandShare__p16371122713578">Minimum: <strong id="ExpandShare__b037172795712">500</strong></p>
<p id="ExpandShare__p937192755712">Maximum: <strong id="ExpandShare__b14371132765712">1048576</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ExpandShare__section437419271573"><h4 class="sectiontitle">Response Parameters</h4><p id="ExpandShare__p12374127155719"><strong id="ExpandShare__b137442715715">Status code: 202</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExpandShare__response_ExpandShareResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="ExpandShare__row1437412713578"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ExpandShare__p1637519277576">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ExpandShare__p53752278574">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ExpandShare__p16375192712578">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExpandShare__row2374202711574"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ExpandShare__p63751127105715">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ExpandShare__p14375427125715">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ExpandShare__p143751927205713">ID of the SFS Turbo file system</p>
</td>
</tr>
<tr id="ExpandShare__row1537417276577"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ExpandShare__p737572785713">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ExpandShare__p237512711578">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ExpandShare__p537682717572">Name of the SFS Turbo file system</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ExpandShare__section16376127185718"><h4 class="sectiontitle">Example Requests</h4><p id="ExpandShare__p9376122795715">Expanding the capacity of a file system to 1,000 GB</p>
<pre class="screen" id="ExpandShare__screen18376142710579">{
"extend" : {
"new_size" : 1000
}
}</pre>
</div>
<div class="section" id="ExpandShare__section63766278575"><h4 class="sectiontitle">Example Responses</h4><p id="ExpandShare__p437772714575"><strong id="ExpandShare__b13771027115717">Status code: 202</strong></p>
<p id="ExpandShare__p143771827185716">Response body for expanding the capacity of a file system</p>
<pre class="screen" id="ExpandShare__screen11377927195713">{
"id" : "67d4bd5e-7b2f-4c24-9a0b-c0038940c6f8",
"name" : "sfs-turbo-test"
}</pre>
</div>
<div class="section" id="ExpandShare__section6377227105717"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ExpandShare__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ExpandShare__row837732713571"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ExpandShare__p11378152705714">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ExpandShare__p14378162735719">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ExpandShare__row12377152745716"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ExpandShare__p2378142713571">202</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ExpandShare__p11378162775713">Response body for expanding the capacity of a file system</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ExpandShare__section23781527165718"><h4 class="sectiontitle">Error Codes</h4><p id="ExpandShare__p1037814277573">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