forked from docs/doc-exports
Wang , Deng Ke
4c6bc53817
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
93 lines
7.0 KiB
HTML
93 lines
7.0 KiB
HTML
<a name="dds_connect_0003"></a><a name="dds_connect_0003"></a>
|
|
|
|
<h1 class="topictitle1">Killing Sessions of an Instance Node</h1>
|
|
<div id="body0000001080874504"><div class="section" id="dds_connect_0003__section276112532416"><h4 class="sectiontitle">Function</h4><p id="dds_connect_0003__p14126162512243">This API is used to kill sessions of an instance node.</p>
|
|
</div>
|
|
<div class="section" id="dds_connect_0003__section07615256244"><h4 class="sectiontitle">Constraints</h4><ul id="dds_connect_0003__ul812632512245"><li id="dds_connect_0003__li1126325122416">Community Edition 3.4, 4.0 and 4.2 instances are supported.</li><li id="dds_connect_0003__li2012612518244">Inactive sessions cannot be terminated.</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_connect_0003__section137742592419"><h4 class="sectiontitle">URI</h4><ul id="dds_connect_0003__ul53354139141429"><li id="dds_connect_0003__li1270098217262">URI format<p id="dds_connect_0003__p174818141875"><a name="dds_connect_0003__li1270098217262"></a><a name="li1270098217262"></a>POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/session</p>
|
|
</li></ul>
|
|
<ul id="dds_connect_0003__ul49831254144655"><li id="dds_connect_0003__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_connect_0003__table12777257249" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="dds_connect_0003__row18126112512410"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.1.1.2.5.1.1"><p id="dds_connect_0003__p171260252243">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.1.1.2.5.1.2"><p id="dds_connect_0003__p11261253245">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.1.1.2.5.1.3"><p id="dds_connect_0003__p1126172512243">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.1.1.2.5.1.4"><p id="dds_connect_0003__p17126325142412">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_connect_0003__row612622532418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="dds_connect_0003__p101261625112415">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="dds_connect_0003__p312622582415">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="dds_connect_0003__p141261925192414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="dds_connect_0003__p1126162516247">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_connect_0003__row31261425112416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.1.2.5.1.1 "><p id="dds_connect_0003__p41261025162416">node_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.1.2.5.1.2 "><p id="dds_connect_0003__p812620256248">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.1.1.2.5.1.3 "><p id="dds_connect_0003__p912662520245">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.1.1.2.5.1.4 "><p id="dds_connect_0003__p191260259249">Specifies the node ID. The following nodes can be queried: mongos nodes in the cluster, and all nodes in the replica set and single node instances.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_connect_0003__section38152582418"><h4 class="sectiontitle">Requests</h4><ul id="dds_connect_0003__ul1961012174116"><li id="dds_connect_0003__li56117144113">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_connect_0003__table5831925102412" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="dds_connect_0003__row712652519244"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dds_connect_0003__p1912682516247">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dds_connect_0003__p1512642532420">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dds_connect_0003__p7126112515249">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dds_connect_0003__p18126102511246">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_connect_0003__row16126425182410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_connect_0003__p1012632552416">sessions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_connect_0003__p14126125142417">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_connect_0003__p11126132572415">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_connect_0003__p9126125152414">Specifies the IDs of sessions to be terminated.</p>
|
|
<p id="dds_connect_0003__p108857910195">For details, see the session ID returned in <a href="dds_connect_0002.html#dds_connect_0002__table599818593239">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="dds_connect_0003__li650973612719">Request example<pre class="codeblock" id="dds_connect_0003__codeblock459392918289">POST https://dds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/nodes/520c58ba00a3497e97ce0b9604874dd6no02/session
|
|
{
|
|
"sessions" : [ "34631", "34703" ]
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="dds_connect_0003__ul6290203212119"><li id="dds_connect_0003__li6290103242112">Example request<pre class="codeblock" id="dds_connect_0003__codeblock203314407220">POST https://dds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/nodes/520c58ba00a3497e97ce0b9604874dd6no02/session
|
|
{
|
|
"sessions" : [ "34631", "34703" ]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_connect_0003__section5861425102416"><h4 class="sectiontitle">Responses</h4><p id="dds_connect_0003__p91738161421">{}</p>
|
|
</div>
|
|
<div class="section" id="dds_connect_0003__section45416163312"><h4 class="sectiontitle">Status Code</h4><p id="dds_connect_0003__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_connect_0003__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_connect_0003__section3541016230"><h4 class="sectiontitle">Error Code</h4><p id="dds_connect_0003__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_connect_0001.html">Connection Management</a></div>
|
|
</div>
|
|
</div>
|
|
|