vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/sfs/api-ref/en-us_topic_0000001537629949.html
zhangyue 5d0d5cb580 SFS API DOC 
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-05-01 07:32:40 +00:00

168 lines
12 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001537629949"></a><a name="EN-US_TOPIC_0000001537629949"></a>
<h1 class="topictitle1">Changing the Name of a File System</h1>
<div id="body0000001537629949"><div class="section" id="EN-US_TOPIC_0000001537629949__section118641741183119"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001537629949__p2071753163010">This API is used to change the name of a file system.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001537629949__section1192711873219"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001537629949__p173435314308">POST /v1/{project_id}/sfs-turbo/shares/{share_id}/action</p>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001537629949__table945125303016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001537629949__row10391753143014"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000001537629949__p1548853123014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000001537629949__p15541253153020">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000001537629949__p145925353013">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000001537629949__p76515333020">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001537629949__row73920537309"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001537629949__p37145318301">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001537629949__p5752533306">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001537629949__p178095310306">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001537629949__p13861053113011">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001537629949__row123985317309"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001537629949__p4917530301">share_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001537629949__p89712536303">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001537629949__p3103153143015">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001537629949__p19108953163020">Specifies the file system ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="EN-US_TOPIC_0000001537629949__section1148912743216"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001537629949__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001537629949__row611845363016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="EN-US_TOPIC_0000001537629949__p3126165373013">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="EN-US_TOPIC_0000001537629949__p31321753143011">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="EN-US_TOPIC_0000001537629949__p313715315304">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="EN-US_TOPIC_0000001537629949__p91411539303">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001537629949__row4118135318308"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001537629949__p1414515313303">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001537629949__p615012532308">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001537629949__p16155753113016">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001537629949__p121624532300">Specifies the account token.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001537629949__row19118953123011"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001537629949__p8168125319301">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001537629949__p917415536301">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001537629949__p1718075318302">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001537629949__p0185195319303">Specifies the MIME type.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001537629949__request_ChangeShareNameReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameter</caption><thead align="left"><tr id="EN-US_TOPIC_0000001537629949__row1219065353019"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="EN-US_TOPIC_0000001537629949__p12198145373014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="EN-US_TOPIC_0000001537629949__p1020413535302">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="EN-US_TOPIC_0000001537629949__p1720816538308">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="EN-US_TOPIC_0000001537629949__p10213105319303">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001537629949__row1619017530309"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="EN-US_TOPIC_0000001537629949__p1721775315300">change_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="EN-US_TOPIC_0000001537629949__p182226532309">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="EN-US_TOPIC_0000001537629949__p142281353153019"><a href="#EN-US_TOPIC_0000001537629949__request_ShareName">ShareName</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="EN-US_TOPIC_0000001537629949__p1923310536309">Specifies the SFS Turbo file system you want to change the name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001537629949__request_ShareName"></a><a name="request_ShareName"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001537629949__request_ShareName" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ShareName</caption><thead align="left"><tr id="EN-US_TOPIC_0000001537629949__row122371453183014"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0000001537629949__p12461753173015">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0000001537629949__p1025185315300">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0000001537629949__p142561253173020">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0000001537629949__p122619538308">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001537629949__row1123745353013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001537629949__p026512537302">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001537629949__p13270185311306">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001537629949__p18275553183013">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001537629949__p528035393019">Specifies the name of the SFS Turbo file system you want to change the name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001537629949__section1176161614331"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000001537629949__p1290153103013">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001537629949__section26738283338"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0000001537629949__screen630355318303">{
"change_name" : {
"name" : "sfs-turbo-test1"
}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000001537629949__section286584113319"><h4 class="sectiontitle">Example Response</h4><p id="EN-US_TOPIC_0000001537629949__p13311053193012">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001537629949__section2533155012332"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001537629949__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001537629949__row163421153133016"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000001537629949__p9348253133014">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="EN-US_TOPIC_0000001537629949__p12353175314307">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001537629949__row234205318304"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001537629949__p4359125315303">204</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001537629949__p43641553133017">Request successful.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001537629949__row18342953103014"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001537629949__p11370155310307">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001537629949__p19375115312303">Invalid parameters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001537629949__row834325315305"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001537629949__p43801753173016">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001537629949__p1038695313306">Internal error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001537629949__row4343155373014"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000001537629949__p163902534309">409</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000001537629949__p13951453103016">File system name already exists.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0000001537629949__p125131122103012"></p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0000001537230113.html">Name Management</a></div>
</div>
</div>
View Git Blame Copy Permalink