doc-exports/docs/sfs/api-ref/sfs_02_0097.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

133 lines
9.2 KiB
HTML

<a name="sfs_02_0097"></a><a name="sfs_02_0097"></a>
<h1 class="topictitle1">Changing a Security Group</h1>
<div id="body0000001072812379"><div class="section" id="sfs_02_0097__section10078954"><h4 class="sectiontitle">Function</h4><p id="sfs_02_0097__p9967154333015">This API is used to change the security group bound to an SFS Turbo file system. Security group change is an asynchronous task. You can determine whether the security group status is changed based on the <strong id="sfs_02_0097__b15791117638">sub_status</strong> field returned in <a href="sfs_02_0054.html">Querying Details About a Single File System</a>. If the <strong id="sfs_02_0097__b174617271237">sub_status</strong> field is <strong id="sfs_02_0097__b026919301533">232</strong>, the security group has been successfully modified.</p>
</div>
<div class="section" id="sfs_02_0097__section23601724"><h4 class="sectiontitle">URI</h4><ul id="sfs_02_0097__ul61482363"><li id="sfs_02_0097__li16470363">URI format<p id="sfs_02_0097__p14015540"><a name="sfs_02_0097__li16470363"></a><a name="li16470363"></a>POST /v1/{project_id}/sfs-turbo/shares/{share_id}/action</p>
</li><li id="sfs_02_0097__li59031001">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0097__table61516961" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0097__row15685300"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="sfs_02_0097__p62549763">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="sfs_02_0097__p33366031">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="sfs_02_0097__p1750013217615">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="sfs_02_0097__p18293951">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0097__row5415035"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0097__p35964716">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="sfs_02_0097__p27460922">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0097__p16500113211620">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0097__p24840910">Specifies the project ID. For details about how to obtain the project ID, see <a href="sfs_02_0001.html">API Usage Guidelines</a>.</p>
</td>
</tr>
<tr id="sfs_02_0097__row20571123"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="sfs_02_0097__p55648230">share_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="sfs_02_0097__p11212819">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="sfs_02_0097__p550013321568">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="sfs_02_0097__p35823136">Specifies the ID of the SFS Turbo file system.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="sfs_02_0097__section11088925"><h4 class="sectiontitle">Request</h4><ul id="sfs_02_0097__ul15992885"><li id="sfs_02_0097__li9718243">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0097__table20355323" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0097__row26131842"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="sfs_02_0097__p36304473">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="sfs_02_0097__p24294565">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="sfs_02_0097__p54981229">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="sfs_02_0097__p21702762">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0097__row13093283"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="sfs_02_0097__p53923001">change_security_group</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="sfs_02_0097__p57988249">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="sfs_02_0097__p5686931">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="sfs_02_0097__p66536629">Specifies the <strong id="sfs_02_0097__b4107102816104">change_security_group</strong> object. For details, see the <a href="#sfs_02_0097__table19964132917205">change_security_group parameter description</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="sfs_02_0097__li7964929112019">change_security_group parameter description
<div class="tablenoborder"><a name="sfs_02_0097__table19964132917205"></a><a name="table19964132917205"></a><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0097__table19964132917205" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0097__row10964029182010"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.2.1.1.5.1.1"><p id="sfs_02_0097__p1396402992014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.2.1.1.5.1.2"><p id="sfs_02_0097__p69647296201">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.2.1.1.5.1.3"><p id="sfs_02_0097__p65255358226">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.99999999999999%" id="mcps1.3.3.2.2.1.1.5.1.4"><p id="sfs_02_0097__p8964112917202">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0097__row7979112912017"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.1.1.5.1.1 "><p id="sfs_02_0097__p17137152317328">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.1.1.5.1.2 "><p id="sfs_02_0097__p1897992915202">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.1.1.5.1.3 "><p id="sfs_02_0097__p4525113511223">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.99999999999999%" headers="mcps1.3.3.2.2.1.1.5.1.4 "><p id="sfs_02_0097__p146831719218">Specifies the ID of the security group to be modified.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="sfs_02_0097__ul20757836"><li id="sfs_02_0097__li52602802">Example request<pre class="screen" id="sfs_02_0097__screen26001441425">{
"change_security_group": {
"security_group_id": "26f6b565-240e-43c3-8867-03f0bd975433"
}
}</pre>
</li></ul>
</div>
<div class="section" id="sfs_02_0097__section32691462"><h4 class="sectiontitle">Response</h4><ul id="sfs_02_0097__ul9130382"><li id="sfs_02_0097__li15064580">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="sfs_02_0097__table1363496" frame="border" border="1" rules="all"><thead align="left"><tr id="sfs_02_0097__row43473456"><th align="left" class="cellrowborder" valign="top" width="20.200000000000003%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="sfs_02_0097__p31689036">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="sfs_02_0097__p16675084">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="sfs_02_0097__p8504536">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="sfs_02_0097__row17778841"><td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="sfs_02_0097__p30800055">id</p>
</td>
<td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="sfs_02_0097__p11776537">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="sfs_02_0097__p14375464">Specifies the ID of the SFS Turbo file system.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="sfs_02_0097__ul5978304"><li id="sfs_02_0097__li53804741">Example response<pre class="screen" id="sfs_02_0097__screen1505182054314">{
"id": "67d4bd5e-7b2f-4c24-9a0b-c0038940c6f8"
}</pre>
<p id="sfs_02_0097__p32079773"></p>
</li></ul>
</div>
<div class="section" id="sfs_02_0097__section25787704"><h4 class="sectiontitle">Status Codes</h4><ul id="sfs_02_0097__ul48324853"><li id="sfs_02_0097__li32270495">Normal</li></ul>
<p class="msonormal" id="sfs_02_0097__p21999005">202</p>
<ul id="sfs_02_0097__ul63773318"><li id="sfs_02_0097__li37088957">Abnormal</li></ul>
<p class="msonormal" id="sfs_02_0097__p65365162">For details, see <a href="sfs_02_0089.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="sfs_02_0096.html">Connection Management</a></div>
</div>
</div>