forked from docs/doc-exports
Wei, Hongmin
61f4bfc2ef
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
175 lines
14 KiB
HTML
175 lines
14 KiB
HTML
<a name="sfs_02_0025"></a><a name="sfs_02_0025"></a>
|
|
|
|
<h1 class="topictitle1">Querying Mount Locations of a Shared File System</h1>
|
|
<div id="body8662426"><div class="section" id="sfs_02_0025__sc9565b85d20d4b76ac01cc09ae82ef6c"><h4 class="sectiontitle">Function</h4><p id="sfs_02_0025__a20069d012a9541ef9d1e092f8d5a2035">This API is used to query mount locations of a shared file system.</p>
|
|
<div class="note" id="sfs_02_0025__note49854297203829"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="sfs_02_0025__p65409348203829">This API exists only when <strong id="sfs_02_0025__b1486015285517">X-Openstack-Manila-Api-Version</strong> in the request header is greater than or equal to 2.9. The following is an example request sent by the <strong id="sfs_02_0025__b842352706152656">curl</strong> command: curl -k -i -X GET https://192.168.196.47:8786/v2/13c7ff9a479c4e3599f4331d9e4a1835/shares/2a8c5470-d5d9-4fe1-b9fc-66a15a162e41/export_locations <strong id="sfs_02_0025__b1523361258152642">-H "X-Openstack-Manila-Api-Version: 2.9"</strong> -H "X-Auth-Token: $token" -H "Accept: application/json"</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="sfs_02_0025__scc4137b0ecc84a588627ed0283ef7582"><h4 class="sectiontitle">URI</h4><ul id="sfs_02_0025__u72fa68f364c4442ba2d248d27de92b8a"><li id="sfs_02_0025__lfff41f913eae4364a652917e86293ed3">GET /v2/{project_id}/shares/{share_id}/export_locations</li><li id="sfs_02_0025__l64e11b8feb704c48a435124955486270">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0025__tf151ace29f074f82b3db38c9d021a642" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0025__r119e607827044610a1ce4f0e30f79e28"><th align="left" class="cellrowborder" valign="top" width="16.458354164583543%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="sfs_02_0025__p17124101410431">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.408659134086594%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="sfs_02_0025__p1612415146430">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.217978202179786%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="sfs_02_0025__p312416148432">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.91500849915009%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="sfs_02_0025__p3124181464318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sfs_02_0025__r5964eb14ebcf469da767c010cdbd35a1"><td class="cellrowborder" valign="top" width="16.458354164583543%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0025__acbabbd1114a74dde86b229e2d01592b7">share_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.408659134086594%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="sfs_02_0025__a28198f20e7214cfe8023b5ad067a5441">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.217978202179786%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0025__a04f245dda8dc4853b2b6a28c1ad280df">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.91500849915009%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0025__en-us_topic_0072841107_p24130518147">Specifies the ID of the shared file system.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0025__r11bf0d0d2f5f4e7ca8d34f6c8449aebc"><td class="cellrowborder" valign="top" width="16.458354164583543%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0025__a7431bfa97a9c4c97925e447350878455">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.408659134086594%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="sfs_02_0025__a51117b683e214b7387f9b9c323c3abbf">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.217978202179786%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0025__a5e09b054a39446f0a7813f37d73fc4bb">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.91500849915009%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0025__a09f81380795242328f7b3934b675d964">Specifies the project ID of the operator.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sfs_02_0025__se53eee3721d54dba9584e7c60eb9cfd4"><h4 class="sectiontitle">Request</h4><ul id="sfs_02_0025__uddfb2683681e4538b46bfa5eaec41450"><li id="sfs_02_0025__le32e1e37d15c469da8d0493902e28231">Parameter description<p id="sfs_02_0025__ade068500a8354f8e8470f465a4508e7d"><a name="sfs_02_0025__le32e1e37d15c469da8d0493902e28231"></a><a name="le32e1e37d15c469da8d0493902e28231"></a>None</p>
|
|
</li><li id="sfs_02_0025__l03c5725f57fd413d9395800a81c1ff31">Example request<p id="sfs_02_0025__af39ef1310fde46beab6f67e6481b1756"><a name="sfs_02_0025__l03c5725f57fd413d9395800a81c1ff31"></a><a name="l03c5725f57fd413d9395800a81c1ff31"></a>None</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sfs_02_0025__sb0a4e7e02465467186f4eac387306edd"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0025__udf771d396d784da59ccf9102e83633bf"><li id="sfs_02_0025__lb7fe9f24467e4d7ea050f143aead01a8">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0025__t6b565351353d435e92d72b89912dd4df" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0025__rb531a383fac5406fbdfd2a152560a594"><th align="left" class="cellrowborder" valign="top" width="26.950000000000003%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="sfs_02_0025__p2358181315814">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.52%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="sfs_02_0025__p12358913185815">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.53%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="sfs_02_0025__p1137381314587">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sfs_02_0025__r8ce8b00eacc747dd897a5834b2232c7a"><td class="cellrowborder" valign="top" width="26.950000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="sfs_02_0025__a213419b985944d4bbc5f357b7b12aa85">export_locations</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.52%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="sfs_02_0025__a35ae2871e368471ab08d91e001f5f0a5">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.53%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="sfs_02_0025__a7acade7e66b648be8946da108d4aab51">Specifies the list of export locations.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li class="litext" id="sfs_02_0025__li1381515012249">Description of field <strong id="sfs_02_0025__b55636508190">export_location</strong>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0025__t466f2739b20d4f53abe4ad046e03f479" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0025__r9f7fb68dbec848f3b74afe863b4622cb"><th align="left" class="cellrowborder" valign="top" width="18.84%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="sfs_02_0025__p78741117115813">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.97%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="sfs_02_0025__p887416172586">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.19%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="sfs_02_0025__p987451775819">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sfs_02_0025__r11e5443fcf8747a7a036b22104d1b976"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0025__a4f5fb4c4a6374b85b7fc9a98b0cc2127">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0025__a071408cb91ef44869f3954fec7b0c3f5">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0025__a7597ba3a14404ccc9bd6ef8939fd7a71">Specifies the ID of the mount location of the shared file system.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0025__r2b5ad9e6bd29487aa4f1d0f6048c4d20"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0025__a30c02f6624ff48d780fd9b9aad8bee2b">share_instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0025__a007fb95a7a0844fe94a4f8a1bb5c5718">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0025__ac7227f13ccd94bff9fd4b5c734d52c0a">Specifies the ID of the shared file system.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0025__r3c308ab16a0942109d9947bd91b1cc6f"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0025__aff714311b21f4ecea647be7b2e32a190">path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0025__a6eab24e4204c4b2f80662bbbca377e64">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0025__af1fc35bd3f1d4fffb728ee033e406d6c">Specifies the path to which the shared file system will be mounted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0025__re452c38520a64d59acec09b4cfeab24e"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0025__a9fc48bfdc4b34061a6566cde9c95216f">is_admin_only</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0025__a536e6c077a2d493695ce7570427e6a07">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0025__a49c9c5cd7ed847ed8ec4944cc9ebfd8c">Specifies whether the shared file system is only visible to administrators and its owner. Possible values are <strong id="sfs_02_0025__b84235270611834">true</strong> (only visible to administrators and its owner) and <strong id="sfs_02_0025__b84235270611829">false</strong> (visible to all users).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0025__r4b61598e77a44112b694ccb715a692c4"><td class="cellrowborder" valign="top" width="18.84%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0025__abe315f4b0405410aaaa5a857c979b2f2">preferred</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0025__aca0819a377ef4c24a8a4142aebabf123">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.19%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="sfs_02_0025__a302833daed9744f3bc813db9a8db1154">Identifies which mount locations are most efficient and are used preferentially when multiple mount locations exist.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="sfs_02_0025__uf29fdfdf75bb4e4282aef72acf0b0ad2"><li id="sfs_02_0025__le34f8c58bf824edb95d5a66c7a1e6692">Example response<div class="p" id="sfs_02_0025__p131050112593"><a name="sfs_02_0025__le34f8c58bf824edb95d5a66c7a1e6692"></a><a name="le34f8c58bf824edb95d5a66c7a1e6692"></a>NFS share:<pre class="screen" id="sfs_02_0025__screen38401315205916">{
|
|
"export_locations": [
|
|
{
|
|
"path": "sfs-nas1.dong.com:/share-236b936a",
|
|
"id": "b03d2aac-aeed-409a-af07-5d1b9024241c",
|
|
"preferred": false
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="sfs_02_0025__p84031855599">CIFS share:<pre class="screen" id="sfs_02_0025__screen1552617055918">{
|
|
"export_locations": [
|
|
{
|
|
"path": "\\\\sfs-nas1.dong.com\\share-4e76e627",
|
|
"id": "85eb5849-1a89-43ae-99ac-2e781514a228",
|
|
"preferred": false
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="sfs_02_0025__sd08ba73f065d437f92fca14d30df0b4e"><h4 class="sectiontitle">Status Codes</h4><ul id="sfs_02_0025__u44b837f0a9464b349bab0900ffa57c24"><li id="sfs_02_0025__lf762d48c9bba4c3cb66dd4eccea71bdb">Normal<p id="sfs_02_0025__aa67f378c78614c8085484e9aaa2ecdb0"><a name="sfs_02_0025__lf762d48c9bba4c3cb66dd4eccea71bdb"></a><a name="lf762d48c9bba4c3cb66dd4eccea71bdb"></a>200</p>
|
|
</li><li id="sfs_02_0025__l24615eb66d584eb79d472dd65f16591e">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0025__t63883f904bd64a27a863345d914aec64" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0025__redad891a904243d3ab39279798e6da21"><th align="left" class="cellrowborder" valign="top" width="43.43%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="sfs_02_0025__a0a2b36124ef44791a32863743d9e29e2">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="sfs_02_0025__en-us_topic_0072841107_p263515418147">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="sfs_02_0025__re40bdaee0f184486b5f31a815a24e576"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0025__a083e91c0b8df43e08cfeb79a62923bd6">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="sfs_02_0025__en-us_topic_0072841107_p125346718147">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0025__rb216fb9efde0473e8d19ca51969c7f15"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0025__aa63843b552c64a66b3317630274fb22b">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="sfs_02_0025__a38c0ce5304ae40339dc6731e7738e2a7">You must enter a username and the password to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0025__raf230c82811e4e0fb90ce019a3fb807e"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0025__en-us_topic_0072841107_p246117518147">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="sfs_02_0025__a7350ca43fcb14bd296228ba24e384bf5">Access to the requested page is forbidden.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="sfs_02_0025__rb84ca596a41549509528f877bb6215d3"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0025__ad7d9aed838c64b48b63a9fd77fa6d9f0">404 Not Found</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="sfs_02_0025__a8bc00eafeaa0448d89a7dd26177f79f6">The requested page was not found.</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>
|
|
|