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

438 lines
37 KiB
HTML
Raw Blame History

<a name="sfs_02_0024"></a><a name="sfs_02_0024"></a>
<h1 class="topictitle1">Querying Details About a Shared File System</h1>
<div id="body8662426"><div class="section" id="sfs_02_0024__sa35e3b1b802c440d80b01848e6abb0d8"><h4 class="sectiontitle">Function</h4><p id="sfs_02_0024__en-us_topic_0064390794_p4308570">This API is used to query the details about a shared file system.</p>
</div>
<div class="section" id="sfs_02_0024__s734971f486b940efb4775991bc6247df"><h4 class="sectiontitle">URI</h4><ul id="sfs_02_0024__en-us_topic_0064390794_ul13449869"><li id="sfs_02_0024__en-us_topic_0064390794_li53939958">GET /v2/{project_id}/shares/{share_id}</li><li id="sfs_02_0024__en-us_topic_0064390794_li63544148">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0024__en-us_topic_0064390794_table35026424" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0024__en-us_topic_0064390794_row976457"><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_0024__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_0024__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_0024__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_0024__p3124181464318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0024__en-us_topic_0064390794_row47357582"><td class="cellrowborder" valign="top" width="16.458354164583543%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0024__aac7ff468e5e141eb8d10c5b8d84aae9b">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_0024__a90b78ed430914480bb4a3a8be3351c7e">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_0024__a3c76a7e2f5ca45a29064883c4f0cd175">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_0024__a5fbbf92ea611436eb7ab37750fd212a4">Specifies the ID of the shared file system.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row20038698"><td class="cellrowborder" valign="top" width="16.458354164583543%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0024__a007bb5af73844806a205886365c1ea38">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_0024__a9c15a356d77a497d8b2206784ea1cf8d">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_0024__a1e454347116f4d32a6ddab1f23458dea">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_0024__a4f33abc5c1084642a0be5319cf1f297a">Specifies the project ID of the operator.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="sfs_02_0024__secb9b5ca6f8a494db9a8aae54bcdddb1"><h4 class="sectiontitle">Request</h4><ul id="sfs_02_0024__en-us_topic_0064390794_ul51305074"><li id="sfs_02_0024__en-us_topic_0064390794_li59092488">Parameter description<p id="sfs_02_0024__en-us_topic_0064390794_p62070345"><a name="sfs_02_0024__en-us_topic_0064390794_li59092488"></a><a name="en-us_topic_0064390794_li59092488"></a>None</p>
</li><li id="sfs_02_0024__en-us_topic_0064390794_li21762200">Example request<p id="sfs_02_0024__en-us_topic_0064390794_p61642077"><a name="sfs_02_0024__en-us_topic_0064390794_li21762200"></a><a name="en-us_topic_0064390794_li21762200"></a>None</p>
</li></ul>
</div>
<div class="section" id="sfs_02_0024__sb8a94205fc72482cb8e91f6c75aa6f0f"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0024__en-us_topic_0064390794_ul26952341"><li id="sfs_02_0024__en-us_topic_0064390794_li41244482">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0024__en-us_topic_0064390794_table35656026" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0024__en-us_topic_0064390794_row59925661"><th align="left" class="cellrowborder" valign="top" width="19.43%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="sfs_02_0024__p183391214165618">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.99%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="sfs_02_0024__p6339191412567">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="sfs_02_0024__p143551414135616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0024__en-us_topic_0064390794_row26965262"><td class="cellrowborder" valign="top" width="19.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="sfs_02_0024__ad48aad8630094c7f8ca05c2593b65a90">share</p>
</td>
<td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="sfs_02_0024__ab99bca782d874b3380113625859621af">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="sfs_02_0024__adbde64fb91f64349abb9c7d8f91dffe5">Specifies the share object.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li class="litext" id="sfs_02_0024__li7662161662414">Description of the <strong id="sfs_02_0024__b14936194235219">share</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0024__table865635334010" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0024__row66561053144018"><th align="left" class="cellrowborder" valign="top" width="18.87%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="sfs_02_0024__p3656853114011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.939999999999998%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="sfs_02_0024__p9656753184012">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_0024__p96561453184014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0024__row18656155374012"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p28090732115456">links</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p60756818115456">Array</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_0024__en-us_topic_0064390794_p53809467171857">Specifies the links of shared file systems.</p>
</td>
</tr>
<tr id="sfs_02_0024__row6656205311402"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p20630446115456">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p60453459115456">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_0024__en-us_topic_0064390794_p35525415171857">Specifies the availability zone.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row5492535895012"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p1976898095012">share_server_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p4995572295012">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_0024__en-us_topic_0064390794_p1988170695012">Specifies the ID for managing share services.</p>
</td>
</tr>
<tr id="sfs_02_0024__row5656135314017"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p27750209115456">share_network_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p33174447115456">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_0024__en-us_topic_0064390794_p59674002171857">Specifies the ID of the share network. This parameter is reserved, because share network management is not supported currently.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row39279891115440"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p39186779115456">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p20012545115456">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_0024__en-us_topic_0064390794_p17092907171857">Specifies the ID of the source snapshot that is used to create the shared file system. This parameter is reserved, because snapshots are not supported currently.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row5321904710035"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p1577556910035">snapshot_support</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p2164239410035">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_0024__p206571653164019">Specifies whether snapshots are supported. This parameter is reserved, because snapshots are not supported currently. This field is supported by API v2.2 and later versions.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row66254026115429"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p66240344115456">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p63867663115456">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_0024__en-us_topic_0064390794_p45589478171857">Specifies the ID of the shared file system.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row25775244115437"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p57485250115456">size</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p25793701115456">Integer</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_0024__en-us_topic_0064390794_p42544068172855">Specifies the size (GB) of the shared file system.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row2811743793851"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__p206584533405">share_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__p1465875384011">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_0024__p86584538409">Specifies the ID of the consistency group. This parameter is reserved, because consistency groups are not supported currently. This field is supported by API versions from v2.31 to v2.42.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row14146850115432"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p43647722115456">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p45804593115456">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_0024__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_0024__en-us_topic_0064390794_row27677209115427"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p30561506115456">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p59562882115456">Object</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_0024__en-us_topic_0064390792_p42083247173855">Sets one or more metadata key and value pairs as a dictionary of strings. <strong id="sfs_02_0024__b184781248290">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_0024__en-us_topic_0064390794_row21024096115415"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p23577146115456">status</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p30700686115456">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_0024__en-us_topic_0064390794_p9195044171857">Specifies the status of the shared file system.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row665580195924"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__p265919537402">task_state</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p5905231595924">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_0024__en-us_topic_0064390794_p1850821095924">Specifies the data migration status. This parameter is reserved, because data migration is not supported currently. This field is supported by API v2.5 and later versions.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row939599610316"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p2287823910316">has_replicas</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p4870772510316">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_0024__en-us_topic_0064390794_p5301165710316">Specifies whether replicas exist. This parameter is reserved, because replication is not supported currently. This field is supported by API versions from v2.11 to v2.42.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row48841735810"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p1388510311817">replication_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__p1366065374015">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_0024__p7660135312409">Specifies the replication type. This parameter is reserved, because replication is not supported currently. This field is supported by API versions from v2.11 to v2.42.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row38372338115421"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p61202789115456">description</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p58478870115456">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_0024__en-us_topic_0064390794_p59409689171857">Describes the shared file system.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row35274029115424"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p58169755115456">host</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p14129699115456">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_0024__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_0024__en-us_topic_0064390794_row10855127115417"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p66003741115456">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p44702790115456">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_0024__en-us_topic_0064390794_p37552527171857">Specifies the name of the shared file system.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row6259894411544"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p66214260115456">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p61754840115456">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_0024__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_0024__en-us_topic_0064390794_row2256685795641"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p1597610695641">access_rules_status</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p6230051595641">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_0024__en-us_topic_0064390794_p1317697095641">Specifies the configuration status of the access rule. Possible values are <strong id="sfs_02_0024__b19546203419592">active</strong> (effective), <strong id="sfs_02_0024__b1754703465911">error</strong> (configuration failed), and <strong id="sfs_02_0024__b12548163412590">syncing</strong> (configuration in progress). This field is supported by API v2.10 and later versions.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row66328432115411"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p11825073115456">share_proto</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p18306875115456">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_0024__en-us_topic_0064390794_p51666373171857">Specifies the protocol for sharing file systems.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row1997612012118"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__p866120531402">share_type_name</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p6682275212118">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_0024__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_0024__en-us_topic_0064390794_row6380688295244"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__p1661195316408">share_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p2135204095244">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_0024__en-us_topic_0064390794_p5179364095244">Specifies the ID of the share type.</p>
</td>
</tr>
<tr id="sfs_02_0024__row356045811811"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__p945114017196">volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__p54519014190">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_0024__p114511106197">Specifies the volume type. The definition of this parameter is the same as that of <strong id="sfs_02_0024__b189076474597">share_type</strong>.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row1256499495932"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__p3662553154018">export_locations</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__p666212536404">Array</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_0024__p366245394013">Lists the mount locations. Currently, only a single mount location is supported. This parameter exists only when <strong id="sfs_02_0024__b127413522592">X-Openstack-Manila-Api-Version</strong> specified in the request header is smaller than <strong id="sfs_02_0024__b5275165210593">2.9</strong>.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row1105050495936"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__p136621153164018">export_location</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__p15662253204012">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_0024__p7662115334014">Specifies the mount location. This parameter exists only when <strong id="sfs_02_0024__b0632175595913">X-Openstack-Manila-Api-Version</strong> specified in the request header is smaller than <strong id="sfs_02_0024__b763335519596">2.9</strong>.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row760346112115"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p1190063912115">is_public</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p2442773012115">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_0024__en-us_topic_0064390794_p19950543172949">Specifies the visibility level of the shared file system. If it is set to <strong id="sfs_02_0024__b1629310588596">true</strong>, the file system can be seen publicly. If it is set to <strong id="sfs_02_0024__b11294155810597">false</strong>, the file system can be seen privately. The default value is <strong id="sfs_02_0024__b52945581598">false</strong>.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row138591369913"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__p116621253104020">source_share_group_snapshot_member_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__en-us_topic_0064390794_p1486018614919">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_0024__p11663125315409">Specifies the ID of the snapshot's source. This parameter is reserved, because consistency snapshots are not supported currently. This field is supported by API v2.31 and later versions.</p>
</td>
</tr>
<tr id="sfs_02_0024__row10663153174013"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__p36631453184015">revert_to_snapshot_support</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__p176631153144013">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_0024__p5663205374018">Specifies whether rollback from snapshot is supported. This parameter is reserved, because snapshots are not supported currently. This field is supported by API v2.27 and later versions.</p>
</td>
</tr>
<tr id="sfs_02_0024__row146631553184010"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__p366385320408">create_share_from_snapshot_support</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__p066315316409">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_0024__p1566325312408">Specifies whether creation of shared file systems from snapshot is supported. This parameter is reserved, because snapshots are not supported currently. This field is supported by API v2.24 and later versions.</p>
</td>
</tr>
<tr id="sfs_02_0024__row12663125334015"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__p1866345364011">mount_snapshot_support</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__p966355374010">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_0024__p266435320407">Specifies whether snapshot mount is supported. This parameter is reserved, because snapshots are not supported currently. This field is supported by API v2.32 and later versions.</p>
</td>
</tr>
<tr id="sfs_02_0024__row4664165311405"><td class="cellrowborder" valign="top" width="18.87%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="sfs_02_0024__p15664105324019">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.939999999999998%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="sfs_02_0024__p866416534403">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_0024__p9664653164011">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_0024__en-us_topic_0064390794_ul51954348"><li id="sfs_02_0024__en-us_topic_0064390794_li64935954">Example response<pre class="screen" id="sfs_02_0024__sd4711959f94642cca167f4c731cd2fc1">{
"share": {
"status": "available",
"share_type_name": "sla",
"description": "My custom share London",
"links": [
{
"href": "https://192.168.196.47:8796/v2/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309",
"rel": "self"
},
{
"href": "https://192.168.196.47:8796/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309",
"rel": "bookmark"
}
],
"availability_zone": "az1.dc1",
"share_network_id": null,
"share_server_id": null,
"share_group_id": null,
"host": "DJ38@a4588256-3880-4136-b3c9-4c3aade8a84b#a4588256-3880-4136-b3c9-4c3aade8a84b",
"revert_to_snapshot_support": null,
"access_rules_status": "active",
"snapshot_id": null,
"create_share_from_snapshot_support": null,
"is_public": false,
"task_state": null,
"snapshot_support": true,
"id": "f26d867f-9876-433d-8db2-25d210f29309",
"size": 1,
"source_share_group_snapshot_member_id": null,
"user_id": "daa3f8f8d7254465841da769298a76f6",
"name": "luzhongguo_1",
"share_type": "8ae4e74e-83f4-4980-8ab8-e637f9294e0b",
"has_replicas": false,
"replication_type": null,
"created_at": "2018-12-25T08:45:22.525899",
"share_proto": "NFS",
"volume_type": "sla",
"mount_snapshot_support": null,
"project_id": "07412155bf474db9a2f697fd978593d7",
"metadata": {
"share_key": "test",
"share_used": "1",
}
}
}</pre>
</li></ul>
</div>
<div class="section" id="sfs_02_0024__sd0bab72141f0458d815c2ca68d706d8d"><h4 class="sectiontitle">Status Codes</h4><ul id="sfs_02_0024__en-us_topic_0064390794_ul26561495"><li id="sfs_02_0024__en-us_topic_0064390794_li37726867">Normal<p id="sfs_02_0024__en-us_topic_0064390794_p3997487"><a name="sfs_02_0024__en-us_topic_0064390794_li37726867"></a><a name="en-us_topic_0064390794_li37726867"></a>200</p>
</li><li id="sfs_02_0024__en-us_topic_0064390794_li35977388">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0024__en-us_topic_0064390794_table55361044" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0024__en-us_topic_0064390794_row7322556"><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_0024__en-us_topic_0064390794_p56256135">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_0024__en-us_topic_0064390794_p60453091">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0024__en-us_topic_0064390794_row64862199"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p19346796">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_0024__en-us_topic_0064390794_p23586666">The server failed to process the request.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row10953403"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p14810456">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_0024__en-us_topic_0064390794_p58796306">You must enter a username and the password to access the requested page.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row59404709"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p47052116">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_0024__en-us_topic_0064390794_p53125076">Access to the requested page is forbidden.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row8363642"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p6366390">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_0024__en-us_topic_0064390794_p45915542">The requested page was not found.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row10586695"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p52215961">405 Method Not Allowed</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_0024__en-us_topic_0064390794_p1634435">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row14709921"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p50652963">406 Not Acceptable</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_0024__en-us_topic_0064390794_p9249362">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row16135397"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p31898818">407 Proxy Authentication Required</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_0024__en-us_topic_0064390794_p33667455">You must use the proxy server for authentication. Then the request can be processed.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row34571641"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p48839530">408 Request Timeout</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_0024__en-us_topic_0064390794_p63687823">The request timed out.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row36319496"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p56198103">409 Conflict</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_0024__en-us_topic_0064390794_p55752527">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row32010697"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p42729680">500 Internal Server Error</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_0024__en-us_topic_0064390794_p38552084">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row11424440"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p52964449">501 Not Implemented</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_0024__en-us_topic_0064390794_p62262011">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row23487194"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p23414560">502 Bad Gateway</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_0024__en-us_topic_0064390794_p17531178">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row23562876"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p29544808">503 Service Unavailable</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_0024__en-us_topic_0064390794_p44319244">Failed to complete the request because the service is unavailable.</p>
</td>
</tr>
<tr id="sfs_02_0024__en-us_topic_0064390794_row63328883"><td class="cellrowborder" valign="top" width="43.43%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="sfs_02_0024__en-us_topic_0064390794_p29365919">504 Gateway Timeout</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_0024__en-us_topic_0064390794_p29829272">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