forked from docs/doc-exports
Chen, Junjie
a03981f7be
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
203 lines
16 KiB
HTML
203 lines
16 KiB
HTML
<a name="dcs-api-0312014"></a><a name="dcs-api-0312014"></a>
|
|
|
|
<h1 class="topictitle1">Querying Statistics of All Running Instances</h1>
|
|
<div id="body14872087"><div class="section" id="dcs-api-0312014__en-us_topic_0166889591_section03501119195511"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312014__en-us_topic_0166889591_p18165174920452">This API is used to query the statistics of all DCS instances that are in the <strong id="dcs-api-0312014__en-us_topic_0166889591_b4482203635110">Running</strong> state.</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312014__en-us_topic_0166889591_section678380145219"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312014__en-us_topic_0166889591_p81872441353">GET /v1.0/{project_id}/instances/statistic</p>
|
|
<div class="p" id="dcs-api-0312014__en-us_topic_0166889591_p356627193519"><a href="#dcs-api-0312014__en-us_topic_0166889591_table8593726183514">Table 1</a> describes the parameter.
|
|
<div class="tablenoborder"><a name="dcs-api-0312014__en-us_topic_0166889591_table8593726183514"></a><a name="en-us_topic_0166889591_table8593726183514"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312014__en-us_topic_0166889591_table8593726183514" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312014__en-us_topic_0166889591_row1759392653515"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312014__en-us_topic_0166889591_p65922269352">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312014__en-us_topic_0166889591_p10592172653513">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312014__en-us_topic_0166889591_p35931926163513">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312014__en-us_topic_0166889591_p1259392633512">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312014__en-us_topic_0166889591_row1593202653513"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312014__en-us_topic_0166889591_p959392614353">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312014__en-us_topic_0166889591_p6593126103516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312014__en-us_topic_0166889591_p1759342693511">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312014__en-us_topic_0166889591_p1359302623515">Project ID. For details on how to obtain the value of this parameter, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312014__en-us_topic_0166889591_section525620116529"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312014__en-us_topic_0166889591_p114924512237"><strong id="dcs-api-0312014__en-us_topic_0166889591_b17489194965114">Request parameters</strong></p>
|
|
<p id="dcs-api-0312014__en-us_topic_0166889591_p184926518234">None</p>
|
|
<p id="dcs-api-0312014__en-us_topic_0166889591_p1549255115230"><strong id="dcs-api-0312014__en-us_topic_0166889591_b11804152125110">Example request</strong></p>
|
|
<pre class="screen" id="dcs-api-0312014__en-us_topic_0166889591_screen411213161369">GET https://{dcs_endpoint}/v1.0/{project_id}/instances/statistic</pre>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312014__en-us_topic_0166889591_section1076710320527"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312014__en-us_topic_0166889591_p3999418102416"><strong id="dcs-api-0312014__en-us_topic_0166889591_b3604259145119">Response parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312014__en-us_topic_0166889591_p678313083514"><a href="#dcs-api-0312014__en-us_topic_0166889591_table254823012351">Table 2</a> describes the response parameter.
|
|
<div class="tablenoborder"><a name="dcs-api-0312014__en-us_topic_0166889591_table254823012351"></a><a name="en-us_topic_0166889591_table254823012351"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312014__en-us_topic_0166889591_table254823012351" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312014__en-us_topic_0166889591_row454823033518"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.2.4.1.1"><p id="dcs-api-0312014__en-us_topic_0166889591_p19271145132518">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.2.4.1.2"><p id="dcs-api-0312014__en-us_topic_0166889591_p2548173053511">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.2.4.1.3"><p id="dcs-api-0312014__en-us_topic_0166889591_p19548183083519">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312014__en-us_topic_0166889591_row8548630153516"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312014__en-us_topic_0166889591_p654873018353">statistics</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312014__en-us_topic_0166889591_p0548153093512">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312014__en-us_topic_0166889591_p205488301359">Statistics of all instances in the <strong id="dcs-api-0312014__en-us_topic_0166889591_b2526205910520">Running</strong> state. For details, see <a href="#dcs-api-0312014__en-us_topic_0166889591_table7914256164">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312014__en-us_topic_0166889591_table7914256164"></a><a name="en-us_topic_0166889591_table7914256164"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312014__en-us_topic_0166889591_table7914256164" frame="border" border="1" rules="all"><caption><b>Table 3 </b>statistics parameter description</caption><thead align="left"><tr id="dcs-api-0312014__en-us_topic_0166889591_row6914195611613"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.4.4.2.4.1.1"><p id="dcs-api-0312014__en-us_topic_0166889591_p1191417569612">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.4.2.4.1.2"><p id="dcs-api-0312014__en-us_topic_0166889591_p1191415613619">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.4.4.2.4.1.3"><p id="dcs-api-0312014__en-us_topic_0166889591_p691414560620">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312014__en-us_topic_0166889591_row1491513561461"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312014__en-us_topic_0166889591_p19915195614617">keys</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312014__en-us_topic_0166889591_p17915125620619">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312014__en-us_topic_0166889591_p79151056865">Number of cached data records</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312014__en-us_topic_0166889591_row19698149103520"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312014__en-us_topic_0166889591_p1114765163510">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312014__en-us_topic_0166889591_p1714815193511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312014__en-us_topic_0166889591_p141482051103516">DCS instance ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312014__en-us_topic_0166889591_row1191516561968"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312014__en-us_topic_0166889591_p18915656968">used_memory</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312014__en-us_topic_0166889591_p14915145615610">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312014__en-us_topic_0166889591_p291565620618">Size of the used memory in MB</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312014__en-us_topic_0166889591_row59151956264"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312014__en-us_topic_0166889591_p13915185611615">max_memory</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312014__en-us_topic_0166889591_p891517562062">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312014__en-us_topic_0166889591_p1991517561466">Overall memory size in MB</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312014__en-us_topic_0166889591_row8915156766"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312014__en-us_topic_0166889591_p49151856163">cmd_get_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312014__en-us_topic_0166889591_p1691515561068">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312014__en-us_topic_0166889591_p39157564612">Number of times the GET command is run</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312014__en-us_topic_0166889591_row139151356469"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312014__en-us_topic_0166889591_p149156569611">cmd_set_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312014__en-us_topic_0166889591_p1091525613614">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312014__en-us_topic_0166889591_p09157568619">Number of times the SET command is run</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312014__en-us_topic_0166889591_row139151156268"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312014__en-us_topic_0166889591_p14915115616613">used_cpu</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312014__en-us_topic_0166889591_p69151656567">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312014__en-us_topic_0166889591_p391520565615">Percentage of CPU usage</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312014__en-us_topic_0166889591_row6915356665"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312014__en-us_topic_0166889591_p1591512568616">input_kbps</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312014__en-us_topic_0166889591_p17916856466">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312014__en-us_topic_0166889591_p391665616610">Incoming traffic (kbit/s) of the DCS instance</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312014__en-us_topic_0166889591_row159161561669"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312014__en-us_topic_0166889591_p391625614617">output_kbps</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312014__en-us_topic_0166889591_p149163561619">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312014__en-us_topic_0166889591_p159161356362">Outgoing traffic (kbit/s) of the DCS instance</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="msonormal" id="dcs-api-0312014__en-us_topic_0166889591_p821715281246"><strong id="dcs-api-0312014__en-us_topic_0166889591_b568361316520">Example response</strong><pre class="screen" id="dcs-api-0312014__en-us_topic_0166889591_screen615810212351">{
|
|
"statistics" : [{
|
|
"keys" : 0,
|
|
"instance_id" : "e008652d-18e0-43ff-924e-072261e0372a",
|
|
"used_memory" : 0,
|
|
"max_memory" : 460,
|
|
"cmd_get_count" : 0,
|
|
"cmd_set_count" : 0,
|
|
"used_cpu" : "0.0",
|
|
"input_kbps" : "0.0",
|
|
"output_kbps" : "0.0"
|
|
}, {
|
|
"keys" : 0,
|
|
"instance_id" : "c577a1eb-33b7-42c7-8231-ad32358599ac",
|
|
"used_memory" : 0,
|
|
"max_memory" : 460,
|
|
"cmd_get_count" : 0,
|
|
"cmd_set_count" : 0,
|
|
"used_cpu" : "0.0",
|
|
"input_kbps" : "0.0",
|
|
"output_kbps" : "0.0"
|
|
}, {
|
|
"keys" : 0,
|
|
"instance_id" : "e8b98471-55d5-4695-b0bb-8f336a98e207",
|
|
"used_memory" : 0,
|
|
"max_memory" : 460,
|
|
"cmd_get_count" : 0,
|
|
"cmd_set_count" : 0,
|
|
"used_cpu" : "0.0",
|
|
"input_kbps" : "0.03",
|
|
"output_kbps" : "1.19"
|
|
}, {
|
|
"keys" : 0,
|
|
"instance_id" : "bc61c690-4b34-4cbe-9ce3-11246aea7aba",
|
|
"used_memory" : 0,
|
|
"max_memory" : 6963,
|
|
"cmd_get_count" : 0,
|
|
"cmd_set_count" : 0,
|
|
"used_cpu" : "0.0",
|
|
"input_kbps" : "0.0",
|
|
"output_kbps" : "0.0"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312014__en-us_topic_0166889591_section143993303124"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312014__en-us_topic_0166889591_p8399153014120"><a href="#dcs-api-0312014__en-us_topic_0166889591_table63992308123">Table 4</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312014__en-us_topic_0166889591_table63992308123"></a><a name="en-us_topic_0166889591_table63992308123"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312014__en-us_topic_0166889591_table63992308123" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312014__en-us_topic_0166889591_row1400230201218"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312014__en-us_topic_0166889591_p14009308126">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.5.3.2.3.1.2"><p id="dcs-api-0312014__en-us_topic_0166889591_p13400203001219">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312014__en-us_topic_0166889591_row540016305125"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312014__en-us_topic_0166889591_p3400163015122">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312014__en-us_topic_0166889591_p24001308129">Statistics of all instances queried successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312035.html">Instance Management APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|