forked from laiweijian4/doc-exports
Wang , Deng Ke
60010eb9d0
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
112 lines
8.8 KiB
HTML
112 lines
8.8 KiB
HTML
<a name="dds_api_0055"></a><a name="dds_api_0055"></a>
|
|
|
|
<h1 class="topictitle1">Changing a Security Group</h1>
|
|
<div id="body1579243011614"><div class="section" id="dds_api_0055__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0055__p3631239417316">This API is used to change the security group associated with a DB instance.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0055__section1239972118494"><h4 class="sectiontitle">Constraints</h4><ul id="dds_api_0055__ul4530787489"><li id="dds_api_0055__li196463467557">Abnormal instances do not support this operation.</li><li id="dds_api_0055__li6504705237">Please confirm the modified security group policy. This policy may affect the current instance connection, causing the connection interruption.</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0055__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0055__ul3084351717316"><li id="dds_api_0055__li915620217316">URI format<p id="dds_api_0055__p912862005412"><a name="dds_api_0055__li915620217316"></a><a name="li915620217316"></a>POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-security-group</p>
|
|
</li><li id="dds_api_0055__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0055__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0055__row60083059"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="dds_api_0055__p34889605"><strong id="dds_api_0055__b67941810144415">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="dds_api_0055__p7485743"><strong id="dds_api_0055__b87521711154416">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="dds_api_0055__p2775334615440"><strong id="dds_api_0055__b868001218445">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0055__row57385070"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0055__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0055__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0055__p57877484163525">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0055__row2864326155157"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0055__p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0055__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0055__p64450739155220">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0055__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0055__ul5099287616954"><li id="dds_api_0055__li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0055__table3678226816954" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0055__row1340482316954"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dds_api_0055__p1204887716954"><strong id="dds_api_0055__b194223315447">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dds_api_0055__p15184124818564"><strong id="dds_api_0055__b135510327449">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dds_api_0055__p3643495116954"><strong id="dds_api_0055__b12280143384412">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dds_api_0055__p222501215320"><strong id="dds_api_0055__b7371334184418">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0055__row794180116954"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0055__p097316195614">security_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0055__p597316135618">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0055__p10975169564">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0055__p697151613568">Specifies the ID of the new security group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0055__ul1041877316954"><li id="dds_api_0055__li2666010016954">Example request<div class="p" id="dds_api_0055__p194803961411"><a name="dds_api_0055__li2666010016954"></a><a name="li2666010016954"></a>POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-security-group<pre class="codeblock" id="dds_api_0055__codeblock1050188101414">{
|
|
"security_group_id": "73bed21a-708b-4985-b697-a96d0e0d2b39"
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0055__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0055__ul12573920"><li id="dds_api_0055__li46056421">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0055__table32267243" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0055__row9230088"><th align="left" class="cellrowborder" valign="top" width="28.442844284428443%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="dds_api_0055__p9439626"><strong id="dds_api_0055__b224137454">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.412441244124413%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="dds_api_0055__p26412257"><strong id="dds_api_0055__b78034143452">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.14471447144714%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="dds_api_0055__p327014214317"><strong id="dds_api_0055__b856911544516">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0055__row15736877"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0055__p4336448205617">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0055__p163361348145613">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0055__p17336104875612">Indicates the workflow ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0055__row263544116490"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0055__p12336184885616">security_group_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0055__p93361348165610">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0055__p83363486568">Indicates the ID of the new security group.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0055__ul16665627"><li id="dds_api_0055__li15772917">Response example<pre class="codeblock" id="dds_api_0055__codeblock660937479172">{
|
|
"job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
|
|
"security_group_id":"73bed21a-708b-4985-b697-a96d0e0d2b39"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0055__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0055__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0055__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0055__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0055__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|