Request Parameters
This request does not contain any parameters.
Request Example
https://192.168.1.1:9081/api/server/usage.ds |
XML and JSON response structure examples are described below.
<drweb-es-api api_version="4.3.2" timestamp="1587044670" server="192.168.1.1" srv_version="13.00.1.202310121" status="true"> <usage> <alert total="3502" size="3135989" failed="0" sent="3502"/> <client agents="0" consoles="0" installs="0" links="0" newbies="0" proxies="0"/> <cluster bytes_in="0" bytes_out="0" messages_in="0" messages_out="0"/> <connections total="0" current="0" maximum="0"/> <vm context_switches="766432" cpu_kernel="3674985100" cpu_user="14969789200" page_faults="1248460" read_cnt="8" write_cnt="977896" threads="41" virtual_memory="1180983296" working_set="100872192"/> <db rows_read="542526" rows_written="51448" statements_fail="0" statements_ok="93240" transactions_rolledback="1" transactions_comitted="50800"/> <repository bytes_in="1408068" bytes_out="543472" files_added="0" files_deleted="0" files_replaced="0" http_fail="1287" http_ok="0"/> <cache> <dns hit="198" missed="254" size="1"/> <file hit="2755" max_msize="386173" max_vsize="386173" vsize="249" missed="48" msize="249"/> <mcastupdate bytes_in="0" bytes_out="0" packets_in="0" packets_out="0"/> <repository hit="619" max_msize="3605106" max_vsize="3615410" missed="0" msize="3605106" vsize="3605106"/> </cache> <load-average> <load1>0.88</load1> <load5>0.57</load5> <load15>0.27</load15> </load-average> <memory> <total>3753</total> <free>827</free> <used-by-server>11</used-by-server> </memory> <fd> <opened>74</opened> <soft-limit>131170</soft-limit> <hard-limit>131170</hard-limit> </fd> </usage> </drweb-es-api> |
Description of XML Response Parameters
The <usage /> element contains information about the Dr.Web Server resource usage.
•The <alert /> element contains information about the Dr.Web Server notifications.
The <alert /> element attributes:
Attribute |
Description |
|---|---|
total |
Total number of generated notifications |
size |
Total size of generated notifications (in kilobytes) |
failed |
Number of unsent notifications |
sent |
Number of successfully sent notifications |
•The <client /> element contains information about clients connected to the Dr.Web Server.
The <client /> element attributes:
Attribute |
Description |
|---|---|
agents |
Number of connected Agents |
consoles |
Number of connected Control Centers |
installs |
Number of the Agent installations currently running |
links |
Number of connected neighbor Dr.Web Servers |
newbies |
Number of newbie stations |
proxies |
Number of Dr.Web Proxy servers |
•The <cluster /> element contains information about a cluster of Dr.Web Servers.
The <cluster /> element attributes:
Attribute |
Description |
|---|---|
bytes_in |
Number of received data (in bytes) |
bytes_out |
Number of sent data (in bytes) |
messages_in |
Number of received messages |
messages_out |
Number of sent messages |
•The <connections /> element contains information about network connections to the Dr.Web Server.
The <connections /> element attributes:
Attribute |
Description |
|---|---|
total |
Total number of allowed connections |
current |
Number of active connections at the moment |
maximum |
Fixed maximum of simultaneous connections |
•The <vm /> element contains information about system resources used on the Dr.Web Server.
The <vm /> element attributes:
Attribute |
Description |
|---|---|
context_switches |
Number of context switches |
cpu_kernel |
CPU operation time in the kernel mode |
cpu_user |
CPU operation time in the user mode |
page_faults |
Number of page faults |
read_cnt |
Number of memory reads |
write_cnt |
Number of memory writes |
virtual_memory |
Virtual memory currently allocated to the Dr.Web Server (in megabytes) |
threads |
Number of running threads |
working_set |
Working set (in megabytes) |
•The <db /> element contains information about the Dr.Web Server database usage.
The <db /> element attributes:
Attribute |
Description |
|---|---|
rows_read |
Number of rows read |
rows_written |
Number of rows written |
statements_fail |
Number of failed statements |
statements_ok |
Number of succeeded statements |
transactions_rolledback |
Number of rolled back transactions |
transactions_comitted |
Number of committed transactions |
•The <repository /> element contains information about the Dr.Web Server repository.
The <repository /> element attributes:
Attribute |
Description |
|---|---|
bytes_in |
Number of received data (in bytes) |
bytes_out |
Number of sent data (in bytes) |
files_added |
Number of new files |
files_deleted |
Number of deleted files |
files_replaced |
Number of replaced files |
http_fail |
Number of failed HTTP requests |
http_ok |
Number of succeeded HTTP requests |
•The <cache /> element contains information about cache usage.
▫The <dns /> element contains information about DNS cache usage.
The <dns /> element attributes:
Attribute |
Description |
|---|---|
hit |
Number of cache hits |
missed |
Number of cache misses |
size |
Current cache size |
▫The <file /> element contains information about file cache usage.
The <file /> element attributes:
Attribute |
Description |
|---|---|
hit |
Number of cache hits |
max_msize |
Maximum cache size (in kilobytes) |
max_vsize |
Maximum virtual cache size (in kilobytes) |
vsize |
Virtual cache size (in kilobytes) |
missed |
Number of cache misses |
msize |
Current cache size (in kilobytes) |
▫The <mcastupdate /> element contains information about cache usage during multicast updates.
The <mcastupdate /> element attributes:
Attribute |
Description |
|---|---|
bytes_in |
Number of received data (in bytes) |
bytes_out |
Number of sent data (in bytes) |
packets_in |
Number of received packages |
packets_out |
Number of sent packages |
▫The <repository /> element contains information about repository cache usage.
The <repository /> element attributes:
Attribute |
Description |
|---|---|
hit |
Number of cache hits |
max_msize |
Maximum cache size |
max_vsize |
Maximum virtual cache size |
missed |
Number of cache misses |
msize |
Current cache size |
vsize |
Virtual cache size |
•The <load-average /> element contains average system load value for a specific period.
▫Nested elements of the <load-average /> element:
Element |
Description |
|---|---|
<load1 /> |
Percentage of system load for 1 minute |
<load5 /> |
Percentage of system load for 5 minutes |
<load15 /> |
Percentage of system load for 15 minutes |
|
Average system load value is calculated for devices running UNIX-based operating systems only. For Windows operating system it always returns the ‘-1’ value. |
•The <memory /> element contains information about the Dr.Web Server RAM.
▫Nested elements of the <memory /> element:
Element |
Description |
|---|---|
<total /> |
Total RAM size (in megabytes) |
<free /> |
Free RAM size (in megabytes) |
<used-by-server /> |
RAM size used by the Dr.Web Server (in megabytes) |
•The <fd /> element contains information about files opened on the Dr.Web Server.
▫The <fd /> element elements:
Element |
Description |
|---|---|
<opened /> |
Number of files opened on the Dr.Web Server |
<soft-limit /> |
Recommended limit number of opened files |
<hard-limit /> |
Strict opened file number limit |
|
The opened file number limit is relevant for devices running UNIX-based operating systems only. |
{ "head": { "status": true, "timestamp": 1587044649, "api": { "version": 40302, "versionString": "4.3.2"}, "server": { "name": "192.168.10.126", "version": "13.00.1.202310121", "uuid": "b35d999d-9212-481d-af8c-8551c4113383"}}, "data": { "usage": { "alert": { "failed": 0, "sent": 3502, "size": 3135989, "total": 3502}, "cache": { "dns": { "hit": 198, "missed": 254}, "size": 1}, "file": { "hit": 2754, "max_msize": 386713, "max_vsize": 386713, "missed": 48, "msize": 249, "vsize": 249}, "mcastupdate": { "bytes_in": 0, "bytes_out": 0, "packets_in": 0, "packets_out": 0}, "repository": { "hit": 619, "max_msize": 3605106, "max_vsize": 3615410, "missed": 0, "msize": 3605106, "vsize": 3605106}}, "client": { "agents": 0, "consoles": 0, "installs": 0, "links": 0, "newbies": 0, "proxies": 0}, "cluster": { "bytes_in": 0, "bytes_out": 0, "messages_in": 0, "messages_out": 0}, "connect": { "current": 0, "maximum": 1, "total": 1}, "db": { "rows_read": 543261, "rows_written": 51448, "statements_fail": 0, "statements_ok": 93305, "transactions_comitted": 50865, "transactions_rolledback": 1}, "fd": { "hard_limit": 131170, "opened": 75, "soft_limit": 131170}, "load_average": { "load1": 1.12, "load15": 0.35, "load5": 0.72}, "memory": { "free": 827, "total": 3753, "used_by_server": 11}, "repository": { "bytes_in": 1408068, "bytes_out": 543472, "files_added": 0, "files_deleted": 0, "files_replaced": 0, "http_fail": 1287, "http_ok": 0}, "vm": { "context_switches": 76622, "cpu_kernel": 3667637600, "cpu_user": 14959185200, "page_faults": 1248427, "read_cnt": 8, "threads": 48, "virtual_memory": 1180983296, "working_set": 100864000, "write_cnt": 977744}}}} |
Description of JSON Response Parameters
The usage block contains information about the Dr.Web Server resource usage.
The usage block elements:
Field name |
Description |
|---|---|
alert |
Block containing information about the Dr.Web Server notifications |
cache |
Block containing information about cache usage |
client |
Block containing information about clients connected to the Dr.Web Server |
cluster |
Block containing information about a cluster of Dr.Web Servers |
connect |
Block containing information about network connections to the Dr.Web Server |
db |
Block containing information about the Dr.Web Server database usage |
fd |
Block containing information about files opened on the Dr.Web Server |
load_average |
Block containing information about average system load for a specific period |
memory |
Block containing information about the Dr.Web Server RAM |
repository |
Block containing information about the Dr.Web Server repository |
vm |
Block containing information about the Dr.Web Server system resource usage |
•The alert block elements:
Field name |
Description |
|---|---|
failed |
Number of unsent notifications |
sent |
Number of successfully sent notifications |
size |
Total size of generated notifications (in kilobytes) |
total |
Total number of generated notifications |
•The cache block elements:
Field name |
Description |
|---|---|
dns |
Block containing information about DNS cache usage |
file |
Block containing information about file cache usage |
mcastupdate |
Block containing information about cache usage during multicast updates |
repository |
Block containing information about repository cache usage |
▫The dns block elements:
Field name |
Description |
|---|---|
hit |
Number of cache hits |
missed |
Number of cache misses |
size |
Current cache size |
▫The file block elements:
Field name |
Description |
|---|---|
hit |
Number of cache hits |
max_msize |
Maximum cache size |
max_vsize |
Maximum virtual cache size |
missed |
Number of cache misses |
msize |
Current cache size |
vsize |
Virtual cache size |
▫The mcastupdate block elements:
Field name |
Description |
|---|---|
bytes_in |
Number of received data (in bytes) |
bytes_out |
Number of sent data (in bytes) |
packets_in |
Number of received packages |
packets_out |
Number of sent packages |
▫The repository block elements:
Field name |
Description |
|---|---|
hit |
Number of cache hits |
max_msize |
Maximum cache size (in kilobytes) |
max_vsize |
Maximum virtual cache size (in kilobytes) |
missed |
Number of cache misses |
msize |
Current cache size (in kilobytes) |
vsize |
Virtual cache size (in kilobytes) |
•The client block elements:
Field name |
Description |
|---|---|
agents |
Number of connected Agents |
consoles |
Number of connected Control Centers |
installs |
Number of the Agent installations currently running |
links |
Number of connected neighbor Dr.Web Servers |
newbies |
Number of newbie stations |
proxies |
Number of Dr.Web Proxy servers |
•The cluster block elements:
Field name |
Description |
|---|---|
bytes_in |
Number of received data (in bytes) |
bytes_out |
Number of sent data (in bytes) |
messages_in |
Number of received messages |
messages_out |
Number of sent messages |
•The connect block elements:
Field name |
Description |
|---|---|
current |
Number of active connections at the moment |
maximum |
Fixed maximum of simultaneous connections |
total |
Total number of allowed connections |
•The db block elements:
Field name |
Description |
|---|---|
rows_read |
Number of rows read |
rows_written |
Number of rows written |
statements_fail |
Number of failed statements |
statements_ok |
Number of succeeded statements |
transactions_comitted |
Number of committed transactions |
transactions_rolledback |
Number of rolled back transactions |
•The fd block elements:
Field name |
Description |
|---|---|
hard_limit |
Strict opened file number limit |
opened |
Number of files opened on the Dr.Web Server |
soft_limit |
Recommended limit number of opened files |
|
The opened file number limit is relevant for devices running UNIX-based operating systems only. |
•The load_average block elements:
Field name |
Description |
|---|---|
load1 |
Percentage of system load for 1 minute |
load15 |
Percentage of system load for 15 minutes |
load5 |
Percentage of system load for 5 minutes |
|
Average system load value is calculated for devices running UNIX-based operating systems only. For Windows operating system it always returns the ‘-1’ value. |
•The memory block elements:
Field name |
Description |
|---|---|
free |
Free RAM size (in megabytes) |
total |
Total RAM size (in megabytes) |
used_by_server |
RAM size used by the Dr.Web Server (in megabytes) |
•The repository block elements:
Field name |
Description |
|---|---|
bytes_in |
Number of received data (in bytes) |
bytes_out |
Number of sent data (in bytes) |
files_added |
Number of new files |
files_deleted |
Number of deleted files |
files_replaced |
Number of replaced files |
http_fail |
Number of failed HTTP requests |
http_ok |
Number of succeeded HTTP requests |
•The vm block elements:
Field name |
Description |
|---|---|
context_switches |
Number of context switches |
cpu_kernel |
CPU operation time in the kernel mode |
cpu_user |
CPU operation time in the user mode |
page_faults |
Number of page faults |
read_cnt |
Number of memory reads |
threads |
Number of running threads |
virtual_memory |
Virtual memory currently allocated to the Dr.Web Server (in megabytes) |
working_set |
Working set (in megabytes) |
write_cnt |
Number of memory writes |