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

406 lines
34 KiB
HTML
Raw Permalink Blame History

<a name="CreateShare"></a><a name="CreateShare"></a>
<h1 class="topictitle1">Creating a File System</h1>
<div id="body16921226115710"><div class="section" id="CreateShare__section10921626195718"><h4 class="sectiontitle">Function</h4><p id="CreateShare__p1292152675718">This API is used to create a file system.</p>
</div>
<div class="section" id="CreateShare__section9921202635711"><h4 class="sectiontitle">URI</h4><p id="CreateShare__p1092115262572">POST /v1/{project_id}/sfs-turbo/shares</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateShare__table169221626145716" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="CreateShare__row99221262573"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateShare__p1892215268570">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateShare__p892392610578">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateShare__p119231626185711">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateShare__p199230269571">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row1922142615719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateShare__p1592392655719">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateShare__p149238268572">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateShare__p1892318264575">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateShare__p16923142655715">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateShare__section2924226105718"><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__row2924142619579"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="CreateShare__p1492512615577">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="CreateShare__p992513263577">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="CreateShare__p1492572695712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="CreateShare__p1192514263571">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row9924142613572"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateShare__p1292516269577">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateShare__p1392532625711">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateShare__p392514265576">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateShare__p159266265570">Account token</p>
</td>
</tr>
<tr id="CreateShare__row17924182655713"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateShare__p3926182625715">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateShare__p1992613262578">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateShare__p139261926105711">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateShare__p159261826175717">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__row29261126195714"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateShare__p149271026105711">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateShare__p692782612571">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateShare__p14927826135719">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateShare__p14928152605716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row5926162619576"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateShare__p10928226175719">share</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateShare__p592872655715">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateShare__p6928426195711"><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__p892817261571">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__row59291267577"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="CreateShare__p13930202614578">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="CreateShare__p69303265574">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="CreateShare__p893111267578">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="CreateShare__p189311926185716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row492942617578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p14931142613572">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p189311926115712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p1193142625714">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p119312260578">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__row79296267578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p5931192619572">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p13932226115710">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p7932202635712">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p993232612579">Description of the file system, which can contain 0 to 255 characters. This parameter is not supported by the current version.</p>
<p id="CreateShare__p1393272614576">Minimum: <strong id="CreateShare__b12932132645716">0</strong></p>
<p id="CreateShare__p2932626125711">Maximum: <strong id="CreateShare__b893262619574">255</strong></p>
</td>
</tr>
<tr id="CreateShare__row13930142615717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p7933826195717">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p17933102612571">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p593392695712"><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__p593382616576">Metadata of the file system. The value consists of key and value pairs as a directory of strings.</p>
</td>
</tr>
<tr id="CreateShare__row14930182625720"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p193317269579">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p14933152625716">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p59331261573">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p893313269578">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>
<p id="CreateShare__p29331426105713">Minimum: <strong id="CreateShare__b8933122695718">4</strong></p>
<p id="CreateShare__p1934112675717">Maximum: <strong id="CreateShare__b20934526175716">64</strong></p>
</td>
</tr>
<tr id="CreateShare__row13930122614574"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p1393422635716">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p5934226195715">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p793462665712">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p1793412617578">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>Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="CreateShare__row1293017263578"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p159349269577">share_proto</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p10934152611572">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p593413268577">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p4935826175713">File sharing protocol. The valid value is <strong id="CreateShare__b10935192685716">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__row18930192615712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p159351264573">share_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p693517269579">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p11935182611575">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__row69301526135711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p1093672645712">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p293652625718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p993662695716">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><ul id="CreateShare__ul1093642610574"><li id="CreateShare__li15936102611576">For a previous-generation SFS Turbo file system, the capacity ranges from <strong id="CreateShare__b1193622695715">500</strong> to <strong id="CreateShare__b7936192616574">32768</strong>, in GiB.</li><li id="CreateShare__li129361726125713">For a previous-generation SFS Turbo file system with <strong id="CreateShare__b693672612576">expand_type="bandwidth"</strong> configured under <strong id="CreateShare__b9936102612572">metadata</strong>, the capacity ranges from <strong id="CreateShare__b39377263573">10240</strong> to <strong id="CreateShare__b5937152611576">3276800</strong>, in GiB.</li><li id="CreateShare__li1493792617571">For a 20 MB/s/TiB file system with <strong id="CreateShare__b1293718265578">expand_type="hpc"</strong> and <strong id="CreateShare__b893782611571">hpc_bw="20M"</strong> configured under <strong id="CreateShare__b693714262570">metadata</strong>, the capacity ranges from <strong id="CreateShare__b493712262573">3686</strong> to <strong id="CreateShare__b8937192655717">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, specify 3686 GiB for a 3.6 TiB file system, 4915 GiB for a 4.8 TiB file system, and 8601 GiB for a 8.4 TiB file system.</li><li id="CreateShare__li1493702619572">For a 40 MB/s/TiB file system with <strong id="CreateShare__b7937202625715">expand_type="hpc"</strong> and <strong id="CreateShare__b15937526145719">hpc_bw="40M"</strong> configured under <strong id="CreateShare__b8937202605711">metadata</strong>, the capacity ranges from <strong id="CreateShare__b11937826155718">1228</strong> to <strong id="CreateShare__b10937102685712">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, specify 3686 GiB for a 3.6 TiB file system, 4915 GiB for a 4.8 TiB file system, and 8601 GiB for a 8.4 TiB file system.</li><li id="CreateShare__li5937126205719">For a 125 MB/s/TiB file system with <strong id="CreateShare__b15937172685716">expand_type="hpc"</strong> and <strong id="CreateShare__b893714261578">hpc_bw="125M"</strong> configured under <strong id="CreateShare__b9937152675716">metadata</strong>, the capacity ranges from <strong id="CreateShare__b3937102618576">1228</strong> to <strong id="CreateShare__b1493722616571">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, specify 3686 GiB for a 3.6 TiB file system, 4915 GiB for a 4.8 TiB file system, and 8601 GiB for a 8.4 TiB file system.</li><li id="CreateShare__li18937326125716">For a 250 MB/s/TiB file system with <strong id="CreateShare__b1493711260576">expand_type="hpc"</strong> and <strong id="CreateShare__b1893710262578">hpc_bw="250M"</strong> configured under <strong id="CreateShare__b8937926105711">metadata</strong>, the capacity ranges from <strong id="CreateShare__b18937102605713">1228</strong> to <strong id="CreateShare__b13937172685711">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, specify 3686 GiB for a 3.6 TiB file system, 4915 GiB for a 4.8 TiB file system, and 8601 GiB for a 8.4 TiB file system.</li></ul>
<p id="CreateShare__p16937202645712"></p>
<p id="CreateShare__p18937726195718"></p>
<p id="CreateShare__p149385262574"></p>
</td>
</tr>
<tr id="CreateShare__row1493062665711"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p59381926135713">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p19938172635713">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p4938826115718">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p393882612571">Subnet ID of a tenant in a VPC. You can obtain the ID from the VPC console or by following the instructions provided in section "Querying Subnets" in <em>Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="CreateShare__row89301126115710"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p693819269572">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p3938192625714">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p19939526105719">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p49391026145720">VPC ID of a tenant in a region. You can obtain the VPC ID from the console or by following the instructions provided in section "Querying VPCs" in <em>Virtual Private Cloud API Reference</em>.</p>
</td>
</tr>
<tr id="CreateShare__row1193002615576"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p1939126155714">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p493942617570">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p893916261570">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="CreateShare__p109399267579">Backup ID. This parameter is mandatory if you create a file system from a backup.</p>
</td>
</tr>
<tr id="CreateShare__row18930426155712"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="CreateShare__p693982635713">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="CreateShare__p1693972616573">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="CreateShare__p4939826105712">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__p189403268576">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__row9940162655710"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="CreateShare__p199411426155714">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="CreateShare__p1794192617576">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="CreateShare__p594114265574">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="CreateShare__p094115262576">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row179401026115716"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateShare__p1594132675711">crypt_key_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateShare__p19941826145717">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateShare__p13942826165712">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="CreateShare__p10942226155710">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__row169401126165717"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateShare__p99435268579">expand_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateShare__p394314266571">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateShare__p109431426165716">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__row09401262573"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="CreateShare__p10944226205717">hpc_bw</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="CreateShare__p179441263573">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="CreateShare__p11944726145716">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="CreateShare__p49441226175718">File system bandwidth.</p>
<p id="CreateShare__p794412665711">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__p994432615717">Specify <strong id="CreateShare__b199459262573">20M</strong> for a 20 MB/s/TiB file system, <strong id="CreateShare__b1494517269573">40M</strong> for a 40 MB/s/TiB file system, <strong id="CreateShare__b1694516268576">125M</strong> for a 125 MB/s/TiB file system, and <strong id="CreateShare__b189455268571">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__row1294514266576"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="CreateShare__p694515262577">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.2"><p id="CreateShare__p179451426195716">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="CreateShare__p4945142610575">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.6.2.5.1.4"><p id="CreateShare__p10946132685711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row694516265575"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="CreateShare__p1294613262578">key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="CreateShare__p1194622619574">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="CreateShare__p1894618266570">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="CreateShare__p2946132655713">Tag key.</p>
<p id="CreateShare__p89461726135715">It can contain a maximum of 128 characters.</p>
<p id="CreateShare__p11946122655711">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="CreateShare__p189469263578">Minimum: <strong id="CreateShare__b129464263574">1</strong></p>
<p id="CreateShare__p294613268579">Maximum: <strong id="CreateShare__b149465267576">128</strong></p>
</td>
</tr>
<tr id="CreateShare__row1594592610577"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="CreateShare__p14946526195710">value</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="CreateShare__p8946162616573">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="CreateShare__p149471226135715">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="CreateShare__p1947132625718">Tag value.</p>
<p id="CreateShare__p149471726165715">Each tag value can contain a maximum of 255 characters and can be an empty string.</p>
<p id="CreateShare__p29476265574">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="CreateShare__p89472026145715">Minimum: <strong id="CreateShare__b10947182618579">0</strong></p>
<p id="CreateShare__p12947132695712">Maximum: <strong id="CreateShare__b15947152611573">255</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateShare__section15275122795719"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateShare__p13275627195711"><strong id="CreateShare__b14275927105710">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__row10952102605717"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateShare__p727542715712">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateShare__p3275132716571">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateShare__p1627532715571">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row8952102655718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateShare__p20275182715577">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateShare__p127562720571">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateShare__p1027542712575">ID of the created SFS Turbo file system</p>
</td>
</tr>
<tr id="CreateShare__row17952526125719"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateShare__p32756273578">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateShare__p82751277576">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateShare__p727513276578">Name of the created SFS Turbo file system</p>
</td>
</tr>
<tr id="CreateShare__row159527264571"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateShare__p227582715714">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateShare__p727592725717">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateShare__p52763273578">Status of the SFS Turbo file system</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateShare__section9276122735717"><h4 class="sectiontitle">Example Requests</h4><ul id="CreateShare__ul427622745716"><li id="CreateShare__li122762027145711">Previous-generation SFS Turbo file system: This example creates an SFS Turbo Standard file system in the AZ whose AZ code is <strong id="CreateShare__b5991103493617">example</strong>, with the file system name set to <strong id="CreateShare__b172762027125718">sfs-turbo-test</strong>, protocol type to NFS, capacity to 500 GB. The security group ID is <strong id="CreateShare__b327614276578">8c4ebbd0-6edf-4aae-8353-xxx</strong>, the subnet ID is <strong id="CreateShare__b16276122785715">b8884abe-f47b-4917-9f6c-xxx</strong>, and the VPC ID is <strong id="CreateShare__b162768279572">d651ea2b-2b20-4c6d-8bbf-xxx</strong>.<pre class="screen" id="CreateShare__screen1727652719574">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__li1827715278574">125 MB/s/TiB: This example creates an SFS Turbo 125 MB/s/TiB file system in the AZ whose AZ code is <strong id="CreateShare__b39591026183715">example</strong>, with the file system name set to <strong id="CreateShare__b1927719271572">sfs-turbo-test</strong>, protocol type to NFS, capacity to 3686 GB. The security group ID is <strong id="CreateShare__b627717271572">8c4ebbd0-6edf-4aae-8353-xxx</strong>, the subnet ID is <strong id="CreateShare__b1327718275573">b8884abe-f47b-4917-9f6c-xxx</strong>, and the VPC ID is <strong id="CreateShare__b192771027175714">d651ea2b-2b20-4c6d-8bbf-xxx</strong>.<pre class="screen" id="CreateShare__screen11277327185710">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__section1027711278572"><h4 class="sectiontitle">Example Responses</h4><p id="CreateShare__p1227732718575"><strong id="CreateShare__b1427742719575">Status code: 202</strong></p>
<p id="CreateShare__p627710272571">Response body for creating a file system</p>
<pre class="screen" id="CreateShare__screen12277427195718">{
"id" : "708c017c-54b5-429a-a098-7692e23fa518",
"name" : "sfs-turbo-test",
"status" : "100"
}</pre>
</div>
<div class="section" id="CreateShare__section16277527175719"><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__row16957826195717"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateShare__p5277202714571">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__p152771627125716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="CreateShare__row1895772617576"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateShare__p1227712271571">202</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateShare__p152772027205712">Response body for creating a file system</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="CreateShare__section192786275574"><h4 class="sectiontitle">Error Codes</h4><p id="CreateShare__p1427819272574">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