vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/sfs/api-ref/sfs_02_0021.html
Wei, Hongmin 61f4bfc2ef SFS API initial version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-18 16:36:56 +00:00

526 lines
46 KiB
HTML
Raw Blame History

<a name="sfs_02_0021"></a><a name="sfs_02_0021"></a>
<h1 class="topictitle1">Creating a Shared File System</h1>
<div id="body8662426"><div class="section" id="sfs_02_0021__sc880cc1b32be442c93ddc31872c5bba9"><h4 class="sectiontitle">Function</h4><p id="sfs_02_0021__ae318f91bf2b84f57b1588f802d79ed7d">This API is used to create a shared file system. After the file system is created, you need to mount the file system to ECSs to achieve shared file storage. </p>
<div class="note" id="sfs_02_0021__n2a30d91894504b8fbfa7a7a5499eca05"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0021__p15051317781">This API is an asynchronous API. If the returned status code is <strong id="sfs_02_0021__b10626324203017">200</strong>, the API request is successfully delivered and received. Later, you can query the status and path of the shared file system by referring to <a href="sfs_02_0024.html">Querying Details About a Shared File System</a> to identify whether the creation is complete and successful. If the status of the shared file system becomes <strong id="sfs_02_0021__b11784184552512">available</strong> or the shared path is generated, the creation is successful.</p>
</div></div>
<div class="notice" id="sfs_02_0021__note4501195513299"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="sfs_02_0021__p158428563292">After a shared file system is created successfully, it can be used only after you add share access rules by referring to <a href="sfs_02_0029.html">Adding Share Access Rules</a>.</p>
</div></div>
</div>
<div class="section" id="sfs_02_0021__s40540b8c32644992ba338ed32c274e1a"><h4 class="sectiontitle">URI</h4><ul id="sfs_02_0021__ub4aa0077165a4a2aaa86e70b7267710a"><li id="sfs_02_0021__l0b44fa9cf5ac4d5ebf049e4fffe1a9ea">POST /v2/{project_id}/shares</li><li id="sfs_02_0021__l46cf58ab60f44ee1aa0706ecc81ea921">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0021__t5f48f75db9b14c6cbfd2879dd1e7c8d1" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0021__ree8732a49c9f4cbfa3cbd26bda2eb442"><th align="left" class="cellrowborder" valign="top" width="24.242424242424242%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="sfs_02_0021__p17124101410431">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="sfs_02_0021__p1612415146430">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.111111111111112%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="sfs_02_0021__p312416148432">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.45454545454546%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="sfs_02_0021__p3124181464318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0021__r7dc74f4a31004f8eb4e868a93369c8a0"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0021__adf798e5d942b4301b652796bdf092f4a">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="sfs_02_0021__a2326f73739854b4fa1892e0648821849">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.111111111111112%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0021__ac77b318c2668498189dbee0fbb5fdb09">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0021__a7f191d8fed27458ba04d994b7c934b80">Specifies the project ID of the operator.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="sfs_02_0021__s836831b048ae41e7abcc3643f6328971"><h4 class="sectiontitle">Request</h4><ul id="sfs_02_0021__uf781e20e56a44e269845245e0fe50b1b"><li id="sfs_02_0021__l46066f8f333d4e3aba444ddd4c1f4c18">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0021__ta99ed8550b4848b7a80ce4606bf642dd" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0021__r9b1296e4f59e4b979ed7edb46aee4ecd"><th align="left" class="cellrowborder" valign="top" width="24.242424242424242%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="sfs_02_0021__p1757642617507">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.191919191919194%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="sfs_02_0021__p18576122611507">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.111111111111112%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="sfs_02_0021__p4591132645017">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.45454545454546%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="sfs_02_0021__p25911826205017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0021__r668380448fc647729cea4b2954700bdb"><td class="cellrowborder" valign="top" width="24.242424242424242%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0021__aecfc60cecb4e440e9e804b3b199fd629">share</p>
</td>
<td class="cellrowborder" valign="top" width="19.191919191919194%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0021__a829cdcbedaf7466a9884bb541705ba82">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="11.111111111111112%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0021__a3f0a2ab9ce5743ae9074158b34089cb4">Object</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454546%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0021__a89908adb44af4223b6805e3cc99a5f43">For details, see the description of the <strong id="sfs_02_0021__b162591515345">share</strong> field.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="sfs_02_0021__li938117882118">Description of the <strong id="sfs_02_0021__b33914337114123">share</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0021__t02fa2a8d319442e18936e45a4b0868e9" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0021__r0d59edb1d3b84778ac0d399ba307cea3"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.3.2.2.2.1.5.1.1"><p id="sfs_02_0021__p89501128115014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.2.2.2.1.5.1.2"><p id="sfs_02_0021__p15950132815504">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.3.2.2.2.1.5.1.3"><p id="sfs_02_0021__p12966112865014">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.3.2.2.2.1.5.1.4"><p id="sfs_02_0021__p4966172895016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0021__r51c142ecbaf2461ba473dee4939fca92"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="sfs_02_0021__abf39f6a279534cb4b823a51069c9102e">share_proto</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="sfs_02_0021__acedc2a0b65b64463b4ceecbe0a4c8fff">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="sfs_02_0021__ae54b1ae095b34db0a389cf59563b381e">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="sfs_02_0021__en-us_topic_0064390791_p918786017377">Specifies the file system sharing protocol. The valid value can be NFS (for Linux OS) or CIFS (for Windows OS).</p>
</td>
</tr>
<tr id="sfs_02_0021__rb6f27e5a457a4ff485aff112009f5f5e"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="sfs_02_0021__ad8bd9fbb693544b29bbc443f93e486b3">size</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="sfs_02_0021__a8faf576e9d954661b4a168718934ec62">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="sfs_02_0021__a06029c2e26cd42debd4becdce81ac1fc">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="sfs_02_0021__a484024b86d384cb7a43cda72ba89c0d2">Specifies the size (GB) of the shared file system. The applied capacity of the shared file system cannot be larger than the allowed quota. To view the allowed quota, see <a href="sfs_02_0032.html">Quota Management</a>.</p>
</td>
</tr>
<tr id="sfs_02_0021__re3d7e94336ce48e080a0203246c79233"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="sfs_02_0021__en-us_topic_0064390791_p556864917377">name</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="sfs_02_0021__a51808a58ff4943d8821a6aa2cd50815e">No</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="sfs_02_0021__a6ec135df9996496b890874cabc7c0069">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="sfs_02_0021__a6e5bd9ce802544a0a1b5db1cc36d16aa">Specifies the name of the shared file system, which contains 0 to 255 characters and can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="sfs_02_0021__r3215dc216ecd4baba1c22f7b8c977ccb"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="sfs_02_0021__ab0014e64ec834c0ca04949c9b99fff6f">description</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="sfs_02_0021__a842ca980f7724dddb00c6f833105a645">No</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="sfs_02_0021__abbaf9735800440888dba5a42f3f7377f">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="sfs_02_0021__ae51bbc680dea4e4b8b8d254a1b75d6e5">Specifies the description of the shared file system, which contains 0 to 255 characters and can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="sfs_02_0021__r662719c5cfa34258af8e257b5c1ea960"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="sfs_02_0021__en-us_topic_0064390791_p835319317377">is_public</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="sfs_02_0021__en-us_topic_0064390791_p552002117377">No</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="sfs_02_0021__a6715ff9ed50b4f0ca762bd5b4483d10e">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="sfs_02_0021__en-us_topic_0064390791_p4518009717377">(Supported by API versions from v2.8 to v2.42). Specifies whether a file system can be publicly seen. If it is set to <strong id="sfs_02_0021__b1592338151712">true</strong>, the file system can be seen publicly. If it is set to <strong id="sfs_02_0021__b119317389173">false</strong>, the file system can be seen privately. The default value is <strong id="sfs_02_0021__b793103818172">false</strong>.</p>
</td>
</tr>
<tr id="sfs_02_0021__r96d56af1208f43ff95b9c166f495547f"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="sfs_02_0021__a41a8c875b39a4f42873c25d2b14ceb27">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="sfs_02_0021__en-us_topic_0064390791_p940226217377">No</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="sfs_02_0021__adc11f31cab9b4ca29fa3a79485facc63">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="sfs_02_0021__a601cd5bbc0b84d549010518ab3700f17">Specifies the availability zone name. If this parameter is left blank, the default availability zone will be used. If the default availability zone contains no storage resources, the creation of the shared file system fails. The value contains 0 to 255 characters.</p>
</td>
</tr>
<tr id="sfs_02_0021__r37b1498aaaf14640a550c276ef015453"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="sfs_02_0021__a4b3268db7b854aeeae9ab4b4245c97e7">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="sfs_02_0021__en-us_topic_0064390791_p992060317377">No</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="sfs_02_0021__a36009adc6677473f8fb24aadb966d861">Object</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="sfs_02_0021__a3d762128ac7f40ddbf20b115af03dafe">Specifies the metadata information used to create the shared file system. The value consists of one or more key and value pairs organized as a dictionary of strings. For details, see the description of the <strong id="sfs_02_0021__b38181233465">metadata</strong> field.</p>
<div class="caution" id="sfs_02_0021__note92849475810"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><ul id="sfs_02_0021__ul67781628350"><li id="sfs_02_0021__li4778122123515">For security concerns, the API for modifying the <strong id="sfs_02_0021__b842352706204348">metadata</strong> field is not opened yet. Therefore, ensure that the parameters and values are correct when creating a shared file system with data encryption using the <strong id="sfs_02_0021__b842352706204358">metadata</strong> field.</li><li id="sfs_02_0021__li10991121112357">Unless otherwise specified (for example, <strong id="sfs_02_0021__b842352706203556">#sfs_crypt_key_id</strong>), the keys that comply with the following rules in the <strong id="sfs_02_0021__b84235270620449">metadata</strong> field are for internal use of the system. Do not customize the settings to avoid internal system errors caused by conflicts with system predefined keys.<ul id="sfs_02_0021__ul54791373516"><li id="sfs_02_0021__li174710131352">Key <strong id="sfs_02_0021__b842352706105824">share_used</strong></li><li id="sfs_02_0021__li247151313513">Keys that start with <strong id="sfs_02_0021__b842352706105911">#sfs</strong></li></ul>
</li></ul>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="sfs_02_0021__li928720519209">Description of <strong id="sfs_02_0021__b132019441353">metadata</strong> fields (creating a shared file system with the encryption function)<div class="p" id="sfs_02_0021__p6342115175815">When creating a shared file system with the encryption function, obtain the key ID, domain ID, and key alias of the encryption key using the HTTPS request by referring to section <strong id="sfs_02_0021__b204897817220269">Querying the List of CMKs</strong> in the <em id="sfs_02_0021__i92221935194719">Key Management Service API Reference</em>. Then, in the <strong id="sfs_02_0021__b842352706204444">metadata</strong> field, set the key-value pairs according to the following table. Ensure that the key-value pairs in the <strong id="sfs_02_0021__b842352706204451">metadata</strong> field are correct.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0021__table122834414587" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0021__row11279184155814"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.3.2.5.1.5.1.1"><p id="sfs_02_0021__p827915418584">Key</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.3.2.3.2.5.1.5.1.2"><p id="sfs_02_0021__p1027924165811">Value Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.3.2.5.1.5.1.3"><p id="sfs_02_0021__p20279144135815">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.3.2.3.2.5.1.5.1.4"><p id="sfs_02_0021__p11279949583">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0021__row162815413589"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.3.2.5.1.5.1.1 "><p id="sfs_02_0021__p17280741589">#sfs_crypt_key_id</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.3.2.5.1.5.1.2 "><p id="sfs_02_0021__p22808415585">String</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.3.2.5.1.5.1.3 "><p id="sfs_02_0021__p72809410588">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.3.2.5.1.5.1.4 "><p id="sfs_02_0021__p1428012465811">Specifies the encryption key ID.</p>
<p id="sfs_02_0021__p1528094155814">If this field, <strong id="sfs_02_0021__b842352706102249">#sfs_crypt_domain_id</strong>, and <strong id="sfs_02_0021__b842352706102259">#sfs_crypt_alias</strong> exist at the same time, the data encryption function is enabled.</p>
</td>
</tr>
<tr id="sfs_02_0021__row1282134135811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.3.2.5.1.5.1.1 "><p id="sfs_02_0021__p92811944582">#sfs_crypt_domain_id</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.3.2.5.1.5.1.2 "><p id="sfs_02_0021__p228116416581">String</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.3.2.5.1.5.1.3 "><p id="sfs_02_0021__p728154195817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.3.2.5.1.5.1.4 "><p id="sfs_02_0021__p42811646587">Specifies the tenant domain ID.</p>
<p id="sfs_02_0021__p122813417588">If this field, <strong id="sfs_02_0021__b1631233953">#sfs_crypt_key_id</strong>, and <strong id="sfs_02_0021__b992016648">#sfs_crypt_alias</strong> exist at the same time, the data encryption function is enabled.</p>
</td>
</tr>
<tr id="sfs_02_0021__row112837445819"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.3.2.5.1.5.1.1 "><p id="sfs_02_0021__p1728284145811">#sfs_crypt_alias</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.3.2.3.2.5.1.5.1.2 "><p id="sfs_02_0021__p02821841582">String</p>
</td>
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.3.2.5.1.5.1.3 "><p id="sfs_02_0021__p02824415586">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.3.2.5.1.5.1.4 "><p id="sfs_02_0021__p1628217410583">Specifies the encryption key alias.</p>
<p id="sfs_02_0021__p152821741585">If this field, <strong id="sfs_02_0021__b1393939978">#sfs_crypt_key_id</strong>, and <strong id="sfs_02_0021__b241659321">#sfs_crypt_domain_id</strong> exist at the same time, the data encryption function is enabled.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="sfs_02_0021__note145511262113"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="sfs_02_0021__ul14877161311128"><li id="sfs_02_0021__li167881119151216">You are advised to use the default primary key <strong id="sfs_02_0021__b842352706155015">sfs/default</strong> to create an encrypted shared file system. For details, see section "File System Encryption" and "Encryption" in the <em id="sfs_02_0021__i842352697155222">Scalable File Service User Guide</em>.</li></ul>
</div></div>
</div>
</li></ul>
<ul id="sfs_02_0021__ue62a04435aa442409ac8ab9192da1e04"><li id="sfs_02_0021__li31136547374">Example request: POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares<pre class="screen" id="sfs_02_0021__s79d94e9838f24d9cba369cce3b4e19f1">{
"share": {
"share_type": null,
"name": "test",
"snapshot_id": null,
"description": "test description",
"share_proto": "NFS",
"share_network_id": null,
"size": 1,
"is_public": false
}
}</pre>
</li></ul>
</div>
<ul id="sfs_02_0021__ul8349113524212"><li id="sfs_02_0021__li735293574218">Example request (creating a shared file system with data encryption function): POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares<pre class="screen" id="sfs_02_0021__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>
</li></ul>
<div class="section" id="sfs_02_0021__s1487e0d77aa44726b32e39e9b52b242b"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0021__ua5fd9d292aba421d83908b0a9ea74388"><li id="sfs_02_0021__l76a6c845449547328651e110a15a103f">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0021__tda30386a6e9d4540a4eb716742253a1b" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0021__r8ada73019fa5407c8e16f6e1f7bc4bb1"><th align="left" class="cellrowborder" valign="top" width="16.93830616938306%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="sfs_02_0021__p88858351506">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.507649235076496%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="sfs_02_0021__p1688543515018">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.55404459554045%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="sfs_02_0021__p18851135175014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0021__r1a20df0633434edc9d860eaf14b9a981"><td class="cellrowborder" valign="top" width="16.93830616938306%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="sfs_02_0021__a7a0494ee07fe4977b3a761e9700c2259">share</p>
</td>
<td class="cellrowborder" valign="top" width="23.507649235076496%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="sfs_02_0021__aab44f3064cf049479255909280c43ccf">Object</p>
</td>
<td class="cellrowborder" valign="top" width="59.55404459554045%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="sfs_02_0021__afa73e2f572e845479878686baa515ac2">For details, see the description of the <strong id="sfs_02_0021__b869211819562">share</strong> field.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="sfs_02_0021__li85221729152117">Description of the <strong id="sfs_02_0021__b1239576793">share</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0021__en-us_topic_0064390794_table28597308" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0021__en-us_topic_0064390794_row26120409"><th align="left" class="cellrowborder" valign="top" width="18.84%" id="mcps1.3.5.2.2.2.1.4.1.1"><p id="sfs_02_0021__p1873317135612">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.91%" id="mcps1.3.5.2.2.2.1.4.1.2"><p id="sfs_02_0021__p473111755617">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.25%" id="mcps1.3.5.2.2.2.1.4.1.3"><p id="sfs_02_0021__p0732017135611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0021__en-us_topic_0064390794_row46308405"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p28090732115456">links</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p60756818115456">Array</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p53809467171857">Specifies the links of shared file systems.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row32071293"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p20630446115456">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p60453459115456">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p35525415171857">Specifies the availability zone.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row5492535895012"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p1976898095012">share_server_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p4995572295012">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p1988170695012">Specifies the ID for managing share services.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row66254026115429"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p66240344115456">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p63867663115456">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p45589478171857">Specifies the ID of the shared file system.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row25775244115437"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p57485250115456">size</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p25793701115456">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p42544068172855">Specifies the size (GB) of the shared file system.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row14146850115432"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p43647722115456">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p45804593115456">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p36017679171857">Specifies the ID of the project to which the shared file system belongs.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row27677209115427"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p30561506115456">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p59562882115456">Object</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390792_p42083247173855">Sets one or more metadata key and value pairs as a dictionary of strings. <strong id="sfs_02_0021__b1139105052915">share_used</strong> is the key, and the corresponding value is the used capacity of the shared file system in the unit of Bytes. </p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row21024096115415"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p23577146115456">status</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p30700686115456">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p9195044171857">Specifies the status of the shared file system.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row38372338115421"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p61202789115456">description</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p58478870115456">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p59409689171857">Describes the shared file system.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row35274029115424"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p58169755115456">host</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p14129699115456">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p24446366171857">Specifies the name of the host. This field is visible only to the administrator.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row10855127115417"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p66003741115456">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p44702790115456">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p37552527171857">Specifies the name of the shared file system.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row6259894411544"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p66214260115456">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p61754840115456">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p62484878171857">Specifies the date and time stamp when the shared file system was created.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row2256685795641"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p1597610695641">access_rules_status</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p6230051595641">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p1317697095641">Specifies the configuration status of the access rule. Possible values are <strong id="sfs_02_0021__b907975238111834">active</strong> (effective), <strong id="sfs_02_0021__b1456498747111834">error</strong> (configuration failed), and <strong id="sfs_02_0021__b1045032779111834">syncing</strong> (configuration in progress). This field is supported by API v2.10 and later versions.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row66328432115411"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p11825073115456">share_proto</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p18306875115456">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p51666373171857">Specifies the protocol for sharing file systems.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row4389128911547"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p745300812118">share_type_name</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p6682275212118">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p55872650172937">Specifies the storage service type assigned for the shared file system, such as high-performance storage (composed of SSDs) and large-capacity storage (composed of SATA disks). This field is supported by API v2.6 and later versions.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row1997612012118"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p97495795244">share_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p2135204095244">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p5179364095244">Specifies the ID of the share type.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row6380688295244"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__p945114017196">volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__p54519014190">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__p114511106197">Specifies the volume type. The definition of this parameter is the same as that of <strong id="sfs_02_0021__b12198418181516">share_type</strong>.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row1256499495932"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p157881131005">export_locations</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p630797391005">Array</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p91852451005">Lists the mount locations. Currently, only a single mount location is supported. This parameter exists only when <strong id="sfs_02_0021__b1232113020245">X-Openstack-Manila-Api-Version</strong> specified in the request header is smaller than <strong id="sfs_02_0021__b1432230122419">2.9</strong>.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row1105050495936"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p522666391005">export_location</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p232762111005">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p63249321005">Specifies the mount location. This parameter exists only when <strong id="sfs_02_0021__b10567185315269">X-Openstack-Manila-Api-Version</strong> specified in the request header is smaller than <strong id="sfs_02_0021__b17568125322617">2.9</strong>.</p>
</td>
</tr>
<tr id="sfs_02_0021__en-us_topic_0064390794_row760346112115"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__en-us_topic_0064390794_p1190063912115">is_public</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__en-us_topic_0064390794_p2442773012115">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__en-us_topic_0064390794_p19950543172949">Specifies the visibility level of the shared file system. If it is set to <strong id="sfs_02_0021__b1554011107273">true</strong>, the file system can be seen publicly. If it is set to <strong id="sfs_02_0021__b354114101275">false</strong>, the file system can be seen privately. The default value is <strong id="sfs_02_0021__b2542010112711">false</strong>.</p>
</td>
</tr>
<tr id="sfs_02_0021__row850218421401"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="sfs_02_0021__p1350254215401">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.91%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="sfs_02_0021__p13502164284012">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.25%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="sfs_02_0021__p205021542164013">Specifies the user ID. This field is supported by API v2.16 and later versions.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="sfs_02_0021__u886e89841962470abf8a0ee25977a353"><li id="sfs_02_0021__l3fd92c7bcd844c49be9367036116203c">Example response<pre class="screen" id="sfs_02_0021__s834879205f854bb4ad165726849c31e4">{
"share": {
"status": "creating",
"project_id": "16e1ab15c35a457e9c2b2aa189f544e1",
"name": "share_London",
"share_type": "25747776-08e5-494f-ab40-a64b9d20d8f7",
"availability_zone": "az1.dc1",
"created_at": "2015-09-18T10:25:24.533287",
"export_location": null,
"links": [
{
"href": "http://192.168.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264",
"rel": "self"
},
{
"href": "http://192.168.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264",
"rel": "bookmark"
}
],
"share_network_id": null,
"export_locations": [],
"share_proto": "NFS",
"host": null,
"volume_type": "default",
"snapshot_id": null,
"is_public": true,
"metadata": {
"project": "my_app",
"aim": "doc"
},
"id": "011d21e2-fbc3-4e4a-9993-9ea223f73264",
"size": 1,
"description": "My custom share London"
}
}</pre>
<div class="note" id="sfs_02_0021__nf04534d78dfe4795b11202bbdfcf6428"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0021__ad60d01005faa40a2b9091fd995277bb6">When the client receives the system response, the shared file system is still being created. For this reason, the shared path cannot be queried immediately. You can use the API of <a href="sfs_02_0025.html">Querying Mount Locations of a Shared File System</a> to query the shared path after the creation is complete.</p>
</div></div>
</li></ul>
</div>
<div class="section" id="sfs_02_0021__sa5e037c233dc48e99754edb2a3e10718"><h4 class="sectiontitle">Status Codes</h4><ul id="sfs_02_0021__uc24b0be3724c46c39b9c718b0530f12b"><li id="sfs_02_0021__l76fe792d4b4447d28280220663e07be2">Normal<p id="sfs_02_0021__ae2df71f8e63047498ed6378ef8836a59"><a name="sfs_02_0021__l76fe792d4b4447d28280220663e07be2"></a><a name="l76fe792d4b4447d28280220663e07be2"></a>200</p>
</li><li id="sfs_02_0021__l2ef62cca323c42e4842f12eaa398e85b">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0021__t2090d44083d34718a5469023c0c64add" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0021__ra369a8c86fba486db6b80296100f3699"><th align="left" class="cellrowborder" valign="top" width="43.43%" id="mcps1.3.6.2.2.1.1.3.1.1"><p id="sfs_02_0021__aef56a0bee1724b0993bff1e74bd97796">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.6.2.2.1.1.3.1.2"><p id="sfs_02_0021__a7923be73f3d642c48f49e12d9f575dbd">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0021__r9caf832a2eb74734a12db37bb5922e9c"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__en-us_topic_0064390791_p887409917377">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__ac915b170d5f2455096491b02762241ac">The server failed to process the request.</p>
</td>
</tr>
<tr id="sfs_02_0021__r10cfd100de64484f99318a78375120ff"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__a8193fd1ffce7479897c3de382c2eed15">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__en-us_topic_0064390791_p52210117377">You must enter a username and the password to access the requested page.</p>
</td>
</tr>
<tr id="sfs_02_0021__r7a403b9870eb4da5b2a875a5b1539ffd"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__adbf7968a9dac42c49b53777be2aaf544">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__a0bc87a6af4f1456e8086bde01aebec6b">Access to the requested page is forbidden.</p>
</td>
</tr>
<tr id="sfs_02_0021__r3422b1bb54164104949a1a121c137932"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__a26dbdb35ea5c4d08b5c6ea8b184b8656">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__acf1017be1cb84275bbbb87052f6ab21a">The requested page was not found.</p>
</td>
</tr>
<tr id="sfs_02_0021__r98d495bd3a4f4d0b87572a4bd4173ce1"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__a8c7636bd87f64006979cb1f8fdf6bbcc">405 Method Not Allowed</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__a969e484ebb1d4f95a1c5d8803eb5805b">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="sfs_02_0021__rde52d6cce4fb49bda58bd438829c8b74"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__en-us_topic_0064390791_p781488717377">406 Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__afa6f5ee4d9d5461ca179b522cbea0d34">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="sfs_02_0021__r101c5bbfb8784aa883c87c38ef66d1ba"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__a4d23d1ea32c3487e8fa03fa7a39543d8">407 Proxy Authentication Required</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__en-us_topic_0064390791_p300388217377">You must use the proxy server for authentication. Then the request can be processed.</p>
</td>
</tr>
<tr id="sfs_02_0021__r6206a8382c46402ab86f280e940f1756"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__a0c0a0346efed4a158e3f78aad3f92502">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__en-us_topic_0064390791_p752846017377">The request timed out.</p>
</td>
</tr>
<tr id="sfs_02_0021__r1f59abfea4d945d5853b088375ec075b"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__a4de368473ace407db9497a6d22044206">409 Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__a1e52611413ef42368e1fc74cedce0b14">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="sfs_02_0021__r33f68eb575084d3d9c7a652797fa1d77"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__a696b29b12cea423cbd6649f0ffd68db8">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__ad20c3d1dc2b146f0a4632048769e0e72">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="sfs_02_0021__rc1e0e831ad8742b6b88bdfea358028be"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__af622f29f0130447f8615637fb7feb757">501 Not Implemented</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__ac3e5fdea4e1d4f7c9d3668ee30ed96f7">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="sfs_02_0021__r1ffb7ea16483434fbcdc681f373bb28d"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__a636bca04b6c74339a4e3f28eaa7e32bc">502 Bad Gateway</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__af68a220ad6d3488cad0a0361f2f94967">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="sfs_02_0021__r6658762006d1444084add1f582fae6bd"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__a71922f19bd4b44a88fc41255846b5660">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__en-us_topic_0064390791_p361803117377">Failed to complete the request because the service is unavailable.</p>
</td>
</tr>
<tr id="sfs_02_0021__rec0c716ad62543e4ac5806fcb22b8c54"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="sfs_02_0021__a612773caf040494fa785db348dd7e335">504 Gateway Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="sfs_02_0021__aa509f60996454e90b1521e61e3da4d9d">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="sfs_02_0020.html">File Sharing</a></div>
</div>
</div>
View Git Blame Copy Permalink