forked from docs/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>
173 lines
13 KiB
HTML
173 lines
13 KiB
HTML
<a name="dds_connect_0004"></a><a name="dds_connect_0004"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Number of Connections to an Instance Node</h1>
|
|
<div id="body0000001133328005"><div class="section" id="dds_connect_0004__section19379596234"><h4 class="sectiontitle">Function</h4><p id="dds_connect_0004__p1226812916718">This API is used to query the number of connections from each client to DDS DB instances.</p>
|
|
</div>
|
|
<div class="section" id="dds_connect_0004__section193915915231"><h4 class="sectiontitle">Constraints</h4><p id="dds_connect_0004__p1379711408716">Frozen instances do not support this operation.</p>
|
|
</div>
|
|
<div class="section" id="dds_connect_0004__section1794313599231"><h4 class="sectiontitle">URI</h4><ul id="dds_connect_0004__ul13194498"><li id="dds_connect_0004__li51641620">URI format<p id="dds_connect_0004__p1163177785"><a name="dds_connect_0004__li51641620"></a><a name="li51641620"></a>GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/conn-statistics?node_id={node_id}</p>
|
|
</li><li id="dds_connect_0004__li22221662">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_connect_0004__table7945559162311" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="dds_connect_0004__row171545018241"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.1.2.5.1.1"><p id="dds_connect_0004__p7154502244">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.1.2.5.1.2"><p id="dds_connect_0004__p1515418013243">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.1.2.5.1.3"><p id="dds_connect_0004__p21541019242">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.1.2.5.1.4"><p id="dds_connect_0004__p21549042416">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_connect_0004__row16154130122418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.2.5.1.1 "><p id="dds_connect_0004__p10154130112410">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.2.5.1.2 "><p id="dds_connect_0004__p101541507245">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.2.5.1.3 "><p id="dds_connect_0004__p11154130122416">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.1.2.5.1.4 "><p id="dds_connect_0004__p1015510112410">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_connect_0004__row615514082411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.2.5.1.1 "><p id="dds_connect_0004__p05321321987">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.2.5.1.2 "><p id="dds_connect_0004__p12155160112413">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.1.2.5.1.3 "><p id="dds_connect_0004__p20155306246">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.1.2.5.1.4 "><p id="dds_connect_0004__p71552018248">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_connect_0004__table9964125918236" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="dds_connect_0004__row131551082419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.2.2.5.1.1"><p id="dds_connect_0004__p215511092419">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.2.2.5.1.2"><p id="dds_connect_0004__p171551806245">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.2.2.5.1.3"><p id="dds_connect_0004__p141550002412">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.2.2.5.1.4"><p id="dds_connect_0004__p81555022416">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_connect_0004__row99867981010"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="dds_connect_0004__p1098689151018">node_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="dds_connect_0004__p10986291107">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="dds_connect_0004__p69865981012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="dds_connect_0004__p12653175220109">Specifies the node ID.</p>
|
|
<p id="dds_connect_0004__p996716913111">If this parameter is left blank, the number of connections of all nodes that can be connected in the instance is queried.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_connect_0004__section179831859172312"><h4 class="sectiontitle">Requests</h4><ul id="dds_connect_0004__ul3196135817427"><li id="dds_connect_0004__li6196155874216">Example request<p id="dds_connect_0004__p891680174312"><a name="dds_connect_0004__li6196155874216"></a><a name="li6196155874216"></a>GET https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/cc6345c64cec47499182467ea0dd432ain02/conn-statistics?node_id=51a90da2cfc846688abcdd23861077b5no02</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_connect_0004__section1984145913233"><h4 class="sectiontitle">Responses</h4><ul id="dds_connect_0004__ul19121154103816"><li id="dds_connect_0004__li15912105453819">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_connect_0004__table1298565922318" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="dds_connect_0004__row715612017248"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="dds_connect_0004__p101567092419">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="dds_connect_0004__p161561601247">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="dds_connect_0004__p17156009249">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_connect_0004__row4156120162414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_connect_0004__p11101131631310">total_connections</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_connect_0004__p315619014248">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_connect_0004__p115613015245">Indicates the total number of connections, including internal and external connections.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_connect_0004__row24391728191319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_connect_0004__p1644032851313">total_inner_connections</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_connect_0004__p644018284136">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_connect_0004__p1044014285132">Indicates the total number of internal connections.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_connect_0004__row204714114615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_connect_0004__p19481441466">total_outer_connections</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_connect_0004__p18481411460">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_connect_0004__p154815454612">Indicates the total number of external connections.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_connect_0004__row1039185064616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_connect_0004__p23925094612">inner_connections</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_connect_0004__p193955034613">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_connect_0004__p1640450164611">Indicates the internal connection statistics array. Up to 200 records are supported. For details, see <a href="#dds_connect_0004__table599818593239">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_connect_0004__row1115650192419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_connect_0004__p1415610032418">outer_connections</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_connect_0004__p31561062416">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_connect_0004__p151562062413">Indicates the external connection statistics array. Up to 200 records are supported. For details, see <a href="#dds_connect_0004__table599818593239">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_connect_0004__table599818593239"></a><a name="table599818593239"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_connect_0004__table599818593239" frame="border" border="1" rules="all"><caption><b>Table 4 </b>QueryConnectionsResponse</caption><thead align="left"><tr id="dds_connect_0004__row31561106242"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="dds_connect_0004__p15156408243">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="dds_connect_0004__p51561304246">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="dds_connect_0004__p715614052411">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_connect_0004__row315640162416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_connect_0004__p13156190182411">client_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_connect_0004__p9156100102415">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_connect_0004__p1615611032418">Indicates the IP address of the client connected to the instance or node.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_connect_0004__row12156202240"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_connect_0004__p11156102243">count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_connect_0004__p71566010248">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_connect_0004__p161562082413">Indicates the number of connections corresponding to the IP address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="dds_connect_0004__ul925644616392"><li id="dds_connect_0004__li4256946173915">Response example<pre class="codeblock" id="dds_connect_0004__codeblock34543414393">{
|
|
"total_connections": 75,
|
|
"total_inner_connections": 50,
|
|
"total_outer_connections": 25,
|
|
"inner_connections": [
|
|
{"client_ip": "10.10.10.24", "count": 19},
|
|
{"client_ip": "9.3.185.42", "count": 6},
|
|
{"client_ip": "10.10.4.156", "count": 3}
|
|
],
|
|
"outer_connections": [
|
|
{"client_ip": "10.10.10.25", "count": 11},
|
|
{"client_ip": "9.3.185.46", "count": 8},
|
|
{"client_ip": "10.10.4.157", "count": 4}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
<div class="section" id="dds_connect_0004__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_connect_0004__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_connect_0004__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_0004__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_connect_0004__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>
|
|
|