yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
26dfc1fff2dd6735fb9ace16a3a59edecfd9873c
doc-exports/docs/sfs/api-ref/CreateShare.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

397 lines
31 KiB
HTML
Raw Blame History

<a name="CreateShare"></a><a name="CreateShare"></a>
<h1 class="topictitle1">Creating a File System</h1>
<div id="body1708331107508"><div class="section" id="CreateShare__section118611332134210"><h4 class="sectiontitle">Function</h4><p id="CreateShare__p3861103234214">This API is used to create a file system.</p>
</div>
<div class="section" id="CreateShare__section1861153274210"><h4 class="sectiontitle">URI</h4><p id="CreateShare__p886193218423">POST /v1/{project_id}/sfs-turbo/shares</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateShare__table17863332164211" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateShare__row168621832174219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateShare__p1986318323424">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateShare__p386303254217">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateShare__p1886343218422">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateShare__p14863193214425">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row14862232124211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateShare__p68640320426">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateShare__p11864193284214">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateShare__p5864153217421">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateShare__p13864432174210">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateShare__section14865123216424"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateShare__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="CreateShare__row1886523211425"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="CreateShare__p68661832114212">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="CreateShare__p386603224211">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="CreateShare__p1686663213422">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="CreateShare__p138661832144215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row7865153284210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateShare__p12866183217425">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateShare__p1686615325423">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateShare__p1386723215423">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateShare__p086723244219">Account token</p>
</td>
</tr>
<tr id="CreateShare__row9865532184214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateShare__p986713325420">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateShare__p11867113213429">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateShare__p188671832164216">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateShare__p6867203213425">MIME type</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateShare__request_CreateShareRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="CreateShare__row886813244211"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateShare__p11868143217420">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateShare__p686913329426">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateShare__p286914324421">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateShare__p486973274214">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row88681932164212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateShare__p2869632144212">share</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateShare__p11869232134215">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateShare__p1387010324429"><a href="#CreateShare__request_Share">Share</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateShare__p168701932194218">Request body for creating a file system</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateShare__request_Share"></a><a name="request_Share"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateShare__request_Share" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Share</caption><thead align="left"><tr id="CreateShare__row11871193212428"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="CreateShare__p1487273204214">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="CreateShare__p13873032164213">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="CreateShare__p2087317328429">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="CreateShare__p138733327424">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row1387153210421"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p16873332194212">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p16873163214219">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p587303212420">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p188731332154216">Code of the AZ where the file system is located. For details about the code, see section "Regions and Endpoints."</p>
</td>
</tr>
<tr id="CreateShare__row13872143218428"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p18873143244219">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p1287433234211">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p188741632164217">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p1587493294217">Description of the file system, which can contain 0 to 255 characters. This parameter is not supported by the current version.</p>
</td>
</tr>
<tr id="CreateShare__row1287273219422"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p0874203224212">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p1087418327428">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p158754324422"><a href="#CreateShare__request_Metadata">Metadata</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p8875193210428">Metadata of the file system. The value consists of key and value pairs as a directory of strings.</p>
</td>
</tr>
<tr id="CreateShare__row118721932124217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p1875183219428">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p88754328427">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p287513217428">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p78751323425">Name of the SFS Turbo file system. The name contains 4 to 64 characters and must start with a letter. It can contain letters (case insensitive), digits, hyphens (-), and underscores (_), and cannot contain other special characters.</p>
</td>
</tr>
<tr id="CreateShare__row68721332174217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p2875632124218">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p118759325426">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p11875183244216">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p19876183220423">Security group ID of a tenant in a region. You can obtain the security group ID from the console or by following the instructions provided in section "Querying Security Groups" in <em id="CreateShare__i1060481724915">Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="CreateShare__row0872123244210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p787616323420">share_proto</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p158761032154213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p14876113244215">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p18876232164211">File sharing protocol. The valid value is <strong id="CreateShare__b48768326428">NFS</strong>. Network File System (NFS) is a distributed file system protocol that allows different computers and operating systems to share data over a network.</p>
</td>
</tr>
<tr id="CreateShare__row487213214422"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p487613326425">share_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p68761632194216">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p20876163234212">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p14935126165711">File system type. Valid values are <strong id="CreateShare__b993592645718">STANDARD</strong> and <strong id="CreateShare__b19935626135713">PERFORMANCE</strong>. This field is not returned when the file system is being created.</p>
<ul id="CreateShare__ul893518263578"><li id="CreateShare__li6935112655712">For a previous-generation SFS Turbo file system, specify <strong id="CreateShare__b1393542665716">STANDARD</strong> for a Standard or Standard - Enhanced file system, and <strong id="CreateShare__b39351260573">PERFORMANCE</strong> for a Performance or Performance - Enhanced file system.</li><li id="CreateShare__li169351626205712">For a 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system, this field is not verified. Specify either <strong id="CreateShare__b893632665717">STANDARD</strong> or <strong id="CreateShare__b593619265579">PERFORMANCE</strong>.</li></ul>
<p id="CreateShare__p99361926135717"></p>
</td>
</tr>
<tr id="CreateShare__row9872183213423"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p6877103214429">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p148771132124215">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p13877732184215">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="CreateShare__ul15877232184215"><li id="CreateShare__li587853220427">SFS Turbo previous-generation file system specifications-file system capacity: The value ranges from 500 to 32768, in GiB.</li><li id="CreateShare__li148781032114213">For an SFS Turbo Enhanced file system, if expand_type is set to bandwidth in the metadata field, the capacity ranges from 10240 to 327680, in GiB.</li><li id="CreateShare__li12878632114218">20MB/s/TiB: If expand_type is set to hpc and hpc_bw is set to 20M in the metadata field, the capacity ranges from 3686 to 1048576, in GiB. The capacity must be a multiple of 1.2 TiB. The value must be rounded down after being converted to GiB. For example, 3.6TiB-&gt;3686GiB, 4.8TiB-&gt;4915GiB, 8.4TiB-&gt;8601GiB.</li><li id="CreateShare__li2878732184220">40MB/s/TiB: If expand_type is set to hpc and hpc_bw is set to 40M in the metadata field, the capacity ranges from 1228 to 1048576, in GiB. The capacity must be a multiple of 1.2 TiB. The value must be rounded down after being converted to GiB. For example, 3.6TiB-&gt;3686GiB, 4.8TiB-&gt;4915GiB, 8.4TiB-&gt;8601GiB.</li><li id="CreateShare__li198781232134211">125MB/s/TiB: If expand_type is set to hpc and hpc_bw is set to 125M in the metadata field, the capacity ranges from 1228 to 1048576, in GiB. The capacity must be a multiple of 1.2 TiB. The value must be rounded down after being converted to GiB. For example, 3.6TiB-&gt;3686GiB, 4.8TiB-&gt;4915GiB, 8.4TiB-&gt;8601GiB.</li><li id="CreateShare__li1187813284214">250MB/s/TiB: If expand_type is set to hpc and hpc_bw is set to 250M in the metadata field, the capacity ranges from 1228 to 1048576, in GiB. The capacity must be a multiple of 1.2 TiB. The value must be rounded down after being converted to GiB. For example, 3.6TiB-&gt;3686GiB, 4.8TiB-&gt;4915GiB, 8.4TiB-&gt;8601GiB.</li></ul>
</td>
</tr>
<tr id="CreateShare__row587223214211"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p1787920320422">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p128791732184220">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p687933215422">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p1387943214423">Subnet ID of a tenant in a VPC</p>
</td>
</tr>
<tr id="CreateShare__row198721532124220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p7879163213427">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p2879532114213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p68792325425">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p587916327422">VPC ID of a tenant in a region</p>
</td>
</tr>
<tr id="CreateShare__row3872103204216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p20879632114213">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p138801532104219">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p19880113244212">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p788033224214">Backup ID. This parameter is mandatory if you create a file system from a backup.</p>
</td>
</tr>
<tr id="CreateShare__row1587211327423"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p10880153214428">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p18880103211421">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p6880532184220">Array of <a href="#CreateShare__request_ResourceTag">ResourceTag</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p98806323422">Tag list</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateShare__request_Metadata"></a><a name="request_Metadata"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateShare__request_Metadata" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Metadata</caption><thead align="left"><tr id="CreateShare__row1988133219422"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="CreateShare__p18881153284215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="CreateShare__p188816327425">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="CreateShare__p19882133234217">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="CreateShare__p688214321421">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row98812032104219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateShare__p28821632154219">crypt_key_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateShare__p888273234211">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateShare__p15882123274217">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="CreateShare__p1388211326425">ID of a KMS professional key. This parameter is used if you want to create an encrypted file system.</p>
</td>
</tr>
<tr id="CreateShare__row16881193214217"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateShare__p1883123212427">expand_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateShare__p1888363216421">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateShare__p78841132194213">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="CreateShare__p1494312615574">Extension type. This parameter is not returned when the file system is being created.</p>
<p id="CreateShare__p194311263574">This parameter is mandatory when you are creating an SFS Turbo 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, 20 MB/s/TiB, or Enhanced file system.</p>
<ul id="CreateShare__ul694332645719"><li id="CreateShare__li294312613572">Specify <strong id="CreateShare__b894422616571">bandwidth</strong> when you are creating a Standard - Enhanced or Performance - Enhanced file system.</li><li id="CreateShare__li294413267579">Specify <strong id="CreateShare__b59441126175714">hpc</strong> when you are creating a 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system.</li></ul>
<p id="CreateShare__p094410267579"></p>
</td>
</tr>
<tr id="CreateShare__row68819323426"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateShare__p12884183215424">hpc_bw</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateShare__p148843324425">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateShare__p10885332114215">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="CreateShare__p16885153210426">File system bandwidth.</p>
<p id="CreateShare__p16885183215421">This parameter is mandatory when you are creating an SFS Turbo 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system.</p>
<p id="CreateShare__p28857321422">Specify <strong id="CreateShare__b10885123264215">20M</strong> for a 20 MB/s/TiB file system, <strong id="CreateShare__b7885132164214">40M</strong> for a 40 MB/s/TiB file system, <strong id="CreateShare__b58851332114213">125M</strong> for a 125 MB/s/TiB file system, and <strong id="CreateShare__b1288563254220">250M</strong> for a 250 MB/s/TiB file system.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="CreateShare__request_ResourceTag"></a><a name="request_ResourceTag"></a><table cellpadding="4" cellspacing="0" summary="" id="CreateShare__request_ResourceTag" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ResourceTag</caption><thead align="left"><tr id="CreateShare__row1288515324427"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="CreateShare__p1688613217425">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.2"><p id="CreateShare__p1188616329420">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="CreateShare__p18861321427">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.6.2.5.1.4"><p id="CreateShare__p388618320429">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row28851332164216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="CreateShare__p4886133214428">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="CreateShare__p88872321421">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="CreateShare__p1888713215424">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="CreateShare__p108875326428">Tag key.</p>
<p id="CreateShare__p3887932184217">It can contain a maximum of 128 characters.</p>
<p id="CreateShare__p15887163213423">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="CreateShare__row9885232134212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="CreateShare__p1788723218423">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="CreateShare__p1588723210429">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="CreateShare__p488773217423">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="CreateShare__p13887103215421">Tag value.</p>
<p id="CreateShare__p19888153284214">Each tag value can contain a maximum of 255 characters and can be an empty string.</p>
<p id="CreateShare__p4888232184219">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>
<div class="section" id="CreateShare__section168914328422"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateShare__p7891132144215"><strong id="CreateShare__b2891332154216">Status code: 202</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateShare__response_CreateShareResponseBody" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="CreateShare__row188911832194216"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateShare__p1789213329428">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateShare__p889214321421">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateShare__p20892832184217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row1889173211421"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateShare__p11892123214211">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateShare__p1489263219424">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateShare__p10892153210423">ID of the created SFS Turbo file system</p>
</td>
</tr>
<tr id="CreateShare__row489113219427"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateShare__p14892173224213">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateShare__p8892032154212">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateShare__p9892932134212">Name of the created SFS Turbo file system</p>
</td>
</tr>
<tr id="CreateShare__row4891193215420"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateShare__p1389293294215">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateShare__p188931432174210">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateShare__p21183354219">Status of the SFS Turbo file system</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateShare__section1811193312421"><h4 class="sectiontitle">Example Requests</h4><ul id="CreateShare__ul1611133374213"><li id="CreateShare__li1611153314212">Previous-generation SFS Turbo file system:<p id="CreateShare__p41123313421"><a name="CreateShare__li1611153314212"></a><a name="li1611153314212"></a>This example creates an SFS Turbo Standard file system in the AZ whose AZ code is <strong id="CreateShare__b111173314212">example</strong>, with the file system name set to <strong id="CreateShare__b911133174214">sfs-turbo-test</strong>, protocol type to NFS, capacity to 500 GB. The security group ID is <strong id="CreateShare__b9119336429">8c4ebbd0-6edf-4aae-8353-xxx</strong>, the subnet ID is <strong id="CreateShare__b191123319425">b8884abe-f47b-4917-9f6c-xxx</strong>, and the VPC ID is <strong id="CreateShare__b181116337425">d651ea2b-2b20-4c6d-8bbf-xxx</strong>.</p>
<pre class="screen" id="CreateShare__screen1711133319426">POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares
{
"share" : {
"name" : "sfs-turbo-test",
"availability_zone" : "example",
"security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx",
"share_proto" : "NFS",
"share_type" : "STANDARD",
"size" : 500,
"subnet_id" : "b8884abe-f47b-4917-9f6c-xxx",
"vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx"
}
}</pre>
</li><li id="CreateShare__li41113333421">125 MB/s/TiB:<p id="CreateShare__p1111133311425"><a name="CreateShare__li41113333421"></a><a name="li41113333421"></a>This example creates an SFS Turbo 125 MB/s/TiB file system in the AZ whose AZ code is <strong id="CreateShare__b1011203384218">example</strong>, with the file system name set to <strong id="CreateShare__b121193312429">sfs-turbo-test</strong>, protocol type to NFS, capacity to 3686 GB. The security group ID is <strong id="CreateShare__b911183364215">8c4ebbd0-6edf-4aae-8353-xxx</strong>, the subnet ID is <strong id="CreateShare__b01116339429">b8884abe-f47b-4917-9f6c-xxx</strong>, and the VPC ID is <strong id="CreateShare__b1711163319423">d651ea2b-2b20-4c6d-8bbf-xxx</strong>.</p>
<pre class="screen" id="CreateShare__screen011433204214">POST HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares
{
"share" : {
"name" : "sfs-turbo-test",
"availability_zone" : "example",
"security_group_id" : "8c4ebbd0-6edf-4aae-8353-xxx",
"share_proto" : "NFS",
"share_type" : "STANDARD",
"size" : 3686,
"subnet_id" : "b8884abe-f47b-4917-9f6c-xxx",
"vpc_id" : "d651ea2b-2b20-4c6d-8bbf-xxx",
"metadata" : {
"expand_type" : "hpc",
"hpc_bw" : "125M"
}
}
}</pre>
</li></ul>
</div>
<div class="section" id="CreateShare__section151213344215"><h4 class="sectiontitle">Example Responses</h4><p id="CreateShare__p1812633124216"><strong id="CreateShare__b31212337426">Status code: 202</strong></p>
<p id="CreateShare__p612103316423">Response body for creating a file system</p>
<pre class="screen" id="CreateShare__screen11219339426">{
"id" : "708c017c-54b5-429a-a098-7692e23fa518",
"name" : "sfs-turbo-test",
"status" : "100"
}</pre>
</div>
<div class="section" id="CreateShare__section312333134217"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateShare__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateShare__row6898203214420"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateShare__p61223319426">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateShare__p41243315423">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row289863294215"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateShare__p1812193384217">202</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateShare__p51213374216">Response body for creating a file system</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateShare__section812193318425"><h4 class="sectiontitle">Error Codes</h4><p id="CreateShare__p171223319422">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