vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/geminidb/api-ref/nosql_05_0103.html
Ru, Li Yi 37b97ffc06 geminidb_api 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-07-04 11:26:33 +00:00

135 lines
9.3 KiB
HTML
Raw Blame History

<a name="nosql_05_0103"></a><a name="nosql_05_0103"></a>
<h1 class="topictitle1">Changing the Security Group of an Instance</h1>
<div id="body111011223122810"><div class="section" id="nosql_05_0103__section14102152317280"><h4 class="sectiontitle">Function</h4><p id="nosql_05_0103__p111031023162819">This API is used to change the security group associated with an instance.</p>
</div>
<div class="section" id="nosql_05_0103__section15431919165"><h4 class="sectiontitle">Constraints</h4><p id="nosql_05_0103__p3567737111013">This API supports GeminiDB Cassandra instances.</p>
<p id="nosql_05_0103__p7325516151015">Abnormal instances do not support this operation.</p>
<p id="nosql_05_0103__p152701189107">Please confirm the modified security group rule. This policy may affect connections to the current instance, interrupting services.</p>
</div>
<div class="section" id="nosql_05_0103__section201211223162813"><h4 class="sectiontitle">URI</h4><p id="nosql_05_0103__p612242319282">PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/security-group</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0103__table17124102312283" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_05_0103__row111230231281"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_05_0103__p91251223102816">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_05_0103__p41271523132813">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_05_0103__p3128923172811">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="nosql_05_0103__p812915234284">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0103__row612322320287"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0103__p1913052319282">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0103__p813112312811">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0103__p1313252311280">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0103__p16133162314282">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="nosql_05_0103__row181234239284"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_05_0103__p2134192362815">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_05_0103__p1713512352820">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_05_0103__p1213611238281">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_05_0103__p141371323202819">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0103__section2138723122817"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0103__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_05_0103__row813912312280"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_05_0103__p1514114233288">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_05_0103__p2142172316280">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_05_0103__p9143162382815">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_05_0103__p714414239281">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0103__row1913919235288"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_05_0103__p634911518305">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_05_0103__p2014616239288">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_05_0103__p161476239282">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_05_0103__p61493232281">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0103__request_UpdateSecurityGroupRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_05_0103__row815012312818"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_05_0103__p19151112310285">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="nosql_05_0103__p5152112392810">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="nosql_05_0103__p2153102312282">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="nosql_05_0103__p415452362811">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0103__row11501523112811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_05_0103__p31559239286">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_05_0103__p1615612382814">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_05_0103__p1715772382811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0103__p181581023122820">ID of the new security group.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0103__section715922302813"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_05_0103__p12160323182815"><strong id="nosql_05_0103__b81553541385">Status code: 202</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0103__response_UpdateSecurityGroupResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_05_0103__row1516162312819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_05_0103__p191638237286">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="nosql_05_0103__p17164152372813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="nosql_05_0103__p11651423192810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0103__row16161112332819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_05_0103__p1316652332810">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_05_0103__p316713231282">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_05_0103__p121680238287">Task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_05_0103__section416912362818"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_05_0103__ul817017237287"><li id="nosql_05_0103__li674321618428">URI example<pre class="screen" id="nosql_05_0103__screen10743816114213">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/security-group</pre>
</li><li id="nosql_05_0103__li1917812236289">Example request body<pre class="screen" id="nosql_05_0103__screen2017916233287">{
"security_group_id" : "73bed21a-708b-4985-b697-a96d0e0d2b39"
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_05_0103__section81821523202815"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_05_0103__p13183122318280"><strong id="nosql_05_0103__b16884356188">Status code: 202</strong></p>
<p id="nosql_05_0103__p718315231287">No Content</p>
<pre class="screen" id="nosql_05_0103__screen1918442318280">{
"job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}</pre>
</div>
<div class="section" id="nosql_05_0103__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_05_0103__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_05_0103__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_05_0103__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000002.html">Instances</a></div>
</div>
</div>
View Git Blame Copy Permalink