forked from docs/doc-exports
Reviewed-by: Muller, Martin <martin.muller@t-systems.com> Co-authored-by: lizaoxu <lizaoxu@huawei.com> Co-committed-by: lizaoxu <lizaoxu@huawei.com>
48 lines
5.7 KiB
HTML
48 lines
5.7 KiB
HTML
<a name="sfs_02_0014"></a><a name="sfs_02_0014"></a>
|
|
|
|
<h1 class="topictitle1">Getting Started (SFS Capacity-Oriented)</h1>
|
|
<div id="body1559726586123"><div class="section" id="sfs_02_0014__section281275461610"><h4 class="sectiontitle">Scenarios</h4><p id="sfs_02_0014__p741020217443">SFS provides high-performance network-attached storage (NAS) that is scalable on demand. A shared file system can be shared with multiple Elastic Cloud Servers (ECSs) and Bare Metal Servers (BMSs). If you need a fully hosted shared file storage and want to access a file system on multiple ECSs, SFS is perfect for you.</p>
|
|
<p id="sfs_02_0014__p12410521204418">The following describes how to call the API for <a href="sfs_02_0021.html">Creating a Shared File System</a>. For details, see <a href="sfs_02_0009.html">Making an API Request</a>.</p>
|
|
</div>
|
|
<div class="section" id="sfs_02_0014__section44739247713"><h4 class="sectiontitle">Prerequisites</h4><p id="sfs_02_0014__p1351318281373">You need to plan the region where a file system resides and determine the endpoint for calling an API based on the region. It can be obtained from <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
|
|
</div>
|
|
<div class="section" id="sfs_02_0014__section847515101583"><h4 class="sectiontitle">Creating a Shared File System</h4><div class="p" id="sfs_02_0014__p10782816889">The following is the sample code about how to create a shared file system with the simplest configurations:<pre class="screen" id="sfs_02_0014__en-us_topic_0064390791_screen196531517377">{
|
|
"share": {
|
|
"description": "test description",
|
|
"share_type": "default",
|
|
"name": "share_London",
|
|
"metadata": {
|
|
"key1": "value1",
|
|
"key2": "value2"
|
|
},
|
|
"share_proto": "NFS",
|
|
"size": 10,
|
|
"is_public": false
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<ul id="sfs_02_0014__ul13946143910111"><li id="sfs_02_0014__li39461939171113"><strong id="sfs_02_0014__b118972411522">description</strong>: Specifies the description of the shared file system, which adds remarks to the shared file system.</li><li id="sfs_02_0014__li2094717399114"><strong id="sfs_02_0014__b11392111111186">share_type</strong>: Specifies the name of a share type. A share type is used to specify the type of the storage service to be allocated.</li><li id="sfs_02_0014__li5947163916114"><strong id="sfs_02_0014__b18496123695710">share_proto</strong>: Specifies the protocol types of the shared file system.</li><li id="sfs_02_0014__li894773918114"><strong id="sfs_02_0014__b4213151713586">name</strong>: Specifies the custom name of the shared file system. For example, <strong id="sfs_02_0014__b5480547185818">share_London</strong>.</li><li id="sfs_02_0014__li9947239141119"><strong id="sfs_02_0014__b610513498593">size</strong>: Specifies the size (in GB) of the shared file system.</li><li id="sfs_02_0014__li179471139101118"><strong id="sfs_02_0014__b1211515474411">is_public</strong>: Specifies the visibility level of the shared file system. If it is set to <strong id="sfs_02_0014__b19718811101312">true</strong>, the file system can be seen publicly. If it is set to <strong id="sfs_02_0014__b77191411181317">false</strong>, the file system can be seen privately. The default value is <strong id="sfs_02_0014__b1872161181311">false</strong>.</li><li id="sfs_02_0014__li98042118519"><strong id="sfs_02_0014__b63314311659">metadata</strong>: Specifies the metadata information of the shared file system. The value consists of one or more key and value pairs organized as a dictionary of strings.</li></ul>
|
|
</div>
|
|
<div class="section" id="sfs_02_0014__section173581612121213"><h4 class="sectiontitle">Creating an Encrypted Shared File System</h4><p id="sfs_02_0014__p1265892615121">You can also encrypt a shared file system. You only need to add parameters related to encryption of a shared file system to the metadata of the request body. The following is an example:</p>
|
|
<pre class="screen" id="sfs_02_0014__screen14359935184218">{
|
|
"share": {
|
|
"share_type": null,
|
|
"name": "test",
|
|
"snapshot_id": null,
|
|
"description": "test description",
|
|
"metadata": {
|
|
"#sfs_crypt_key_id": "9130c90d-73b8-4203-b790-d49f98d503df",
|
|
"#sfs_crypt_domain_id": "3b2d9670690444c582942801ed7d457b",
|
|
"#sfs_crypt_alias": "sfs/default"
|
|
},
|
|
"share_proto": "NFS",
|
|
"share_network_id": null,
|
|
"size": 1,
|
|
"is_public": false
|
|
}
|
|
}</pre>
|
|
<ul id="sfs_02_0014__ul281147101818"><li id="sfs_02_0014__li10828476187"><strong id="sfs_02_0014__b135459819104">#sfs_crypt_key_id</strong>: Specifies the encryption key ID. If <strong id="sfs_02_0014__b39866814912">#sfs_crypt_key_id</strong>, <strong id="sfs_02_0014__b842352706102249">#sfs_crypt_domain_id</strong>, and <strong id="sfs_02_0014__b842352706102259">#sfs_crypt_alias</strong> exist at the same time, the data encryption function is enabled.</li><li id="sfs_02_0014__li116161011887"><strong id="sfs_02_0014__b121083287124">#sfs_crypt_domain_id</strong>: Specifies the tenant domain ID. If <strong id="sfs_02_0014__b2978194911">#sfs_crypt_domain_id</strong>, <strong id="sfs_02_0014__b1042501305">#sfs_crypt_key_id</strong>, and <strong id="sfs_02_0014__b1194457898">#sfs_crypt_alias</strong> exist at the same time, the data encryption function is enabled.</li><li id="sfs_02_0014__li184110121816"><strong id="sfs_02_0014__b1589119542136">#sfs_crypt_alias</strong>: Specifies the encryption key alias. If <strong id="sfs_02_0014__b1913312304919">#sfs_crypt_alias</strong>, <strong id="sfs_02_0014__b1951830176">#sfs_crypt_key_id</strong>, and <strong id="sfs_02_0014__b498430989">#sfs_crypt_domain_id</strong> exist at the same time, the data encryption function is enabled.</li></ul>
|
|
</div>
|
|
</div>
|
|
|