|
Request Example
http://192.168.1.1:9080/api/server/usage.ds
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1407727071" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<usage>
<alert total="10993" size="2358668" failed="0" sent="6076"/>
<client agents="0" consoles="0" installs="0" links="0" newbies="0"/>
<cluster bytes_in="0" bytes_out="0" messages_in="0" messages_out="0"/>
<connections total="1" current="0" maximum="1"/>
<vm context_switches="104738797" cpu_kernel="361442162700" cpu_user="476860853400" page_faults="3693724" read_cnt="16383440" write_cnt="10204496" threads="29" virtual_memory="3380195328" working_set="161349632"/>
<db rows_read="871190" rows_written="113655" statements_fail="3" statements_ok="208617" transactions_rolledback="6" transactions_comitted="168782"/>
<repository bytes_in="798755259" bytes_out="6298608" files_added="1835" files_deleted="490" files_replaced="942" http_fail="172" http_ok="8375"/>
<cache>
<dns hit="11376" missed="1168" size="1"/>
<file hit="68635" max_msize="3173869" max_vsize="3173869" vsize="752571" missed="15316" msize="752571"/>
<mcastupdate bytes_in="0" bytes_out="0" packets_in="0" packets_out="0"/>
<repository hit="784" max_msize="3356873" max_vsize="3366187" missed="0" msize="0" vsize="0"/>
</cache>
<load-average>
<load1>0.19</load1>
<load5>0.18</load5>
<load15>0.12</load15>
</load-average>
<memory>
<total>2897</total>
<free>111</free>
<used-by-server>73</used-by-server>
</memory>
</usage>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <alert /> element contains information on the Server notifications. The <alert /> element attributes:
Attribute
|
Description
|
total
|
Total number of generated notifications
|
size
|
Total size of generated notifications
|
failed
|
Number of unsent notifications
|
sent
|
Number of successfully sent notifications
|
•The <client /> element contains information on the clients connected to the 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 Servers
|
newbies
|
Number of newbies
|
•The <cluster /> element contains information on the Servers cluster. 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 on the Server network connections. 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 on a usage of system resources on the computer with the Server installed. 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 read
|
write_cnt
|
Number of memory write
|
virtual_memory
|
Virtual memory currently allocated to the Server
|
threads
|
Number of running threads
|
working_set
|
Working set
|
•The <db /> element contains information on the Server database usage. The <db /> element attributes:
Attribute
|
Description
|
rows_read
|
Number of read rows
|
rows_written
|
Number of written rows
|
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 on the 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 added
|
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 on a cache usage. ▫The <dns /> element contains information on 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 on usage of the file cache. The <file /> element attributes:
Attribute
|
Description
|
hit
|
Number of cache hits
|
max_msize
|
Maximum cache size
|
max_vsize
|
Maximum virtual cache size
|
vsize
|
Virtual cache size
|
missed
|
Number of cache misses
|
msize
|
Current cache size
|
▫The <mcastupdate /> element contains information on 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 on 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 load of a system for a certain period. Nested elements of the <load-average /> element:
Attribute
|
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
|
•The <memory> element contains information on operative memory of the computer on which the Server is installed. Nested elements of the <memory> element:
Attribute
|
Description
|
<total>
|
Total amount of operative memory
|
<free>
|
Amount of free operative memory
|
<used-by-server>
|
Amount of operative memory used by the Server
|
JSON Response Structure
{
"head": {
"status": true,
"timestamp": 1499817595,
"api": {
"version": 40103
},
"server": {
"name": "192.168.10.126",
"version": "1000201707130",
"uuid": "42579e9c-8ff2-436b-ab73-0be374fcd289"
}
},
"data": {
"usage": {
"connections": {
"total": 1,
"current": 0,
"maximum": 1
},
"cache": {
"mcastupdate": {
"packets_in": 0,
"bytes_in": 0,
"packets_out": 0,
"bytes_out": 0
},
"file": {
"max_msize": 3173869,
"hit": 68821,
"max_vsize": 3173869,
"missed": 15316,
"msize": 752571,
"vsize": 752571
},
"dns": {
"size": 1,
"missed": 1169,
"hit": 11385
},
"repository": {
"max_msize": 3356873,
"hit": 785,
"max_vsize": 3366187,
"missed": 0,
"msize": 6299,
"vsize": 6299
}
},
"load_average": {
"load1": 0.09,
"load5": 0.16,
"load15": 0.12
},
"memory": {
"total": 2897,
"used_by_server": 75,
"free": 144
},
"cluster": {
"bytes_out": 0,
"messages_out": 0,
"bytes_in": 0,
"messages_in": 0
},
"repository": {
"bytes_out": 6308034,
"files_added": 1835,
"files_replaced": 947,
"http_fail": 172,
"files_deleted": 490,
"bytes_in": 807992150,
"http_ok": 8392
},
"db": {
"statements_ok": 208671,
"transactions_comitted": 168827,
"rows_read": 871876,
"statements_fail": 3,
"rows_written": 113673,
"transactions_rolledback": 6
},
"client": {
"agents": 0,
"consoles": 0,
"newbies": 0,
"installs": 0,
"links": 0
},
"alert": {
"sent": 6081,
"total": 11003,
"failed": 0,
"size": 2360950
},
"vm": {
"read_cnt": 16514488,
"virtual_memory": 3380199424,
"page_faults": 3706414,
"write_cnt": 10234232,
"threads": 29,
"working_set": 165400576,
"context_switches": 104758312,
"cpu_kernel": 361651505400,
"cpu_user": 477667822800
}
}
}
}
|
Description of JSON Response Parameters
•Theconnections block contains information on the Server network connections. The connections block elements:
Attribute
|
Description
|
total
|
Total number of allowed connections
|
current
|
Number of active connections at the moment
|
maximum
|
Fixed maximum of simultaneous connections
|
•The cache block contains information on a cache usage. ▫The mcastupdate block contains information on cache usage during multicast updates. The mcastupdate block elements:
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 file block contains information on usage of the file cache. The file block elements:
Attribute
|
Description
|
hit
|
Number of cache hits
|
max_msize
|
Maximum cache size
|
max_vsize
|
Maximum virtual cache size
|
vsize
|
Virtual cache size
|
missed
|
Number of cache misses
|
msize
|
Current cache size
|
▫The dns block contains information on DNS cache usage. The dns block elements:
Attribute
|
Description
|
hit
|
Number of cache hits
|
missed
|
Number of cache misses
|
size
|
Current cache size
|
▫The repository block included into the cache block, contains information on repository cache usage. The repository block elements:
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 block contains average load of a system for a certain period. The load_average block elements:
Attribute
|
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
|
•The memory block contains information on operative memory of the computer on which the Server is installed. The memory block elements:
Attribute
|
Description
|
total
|
Total amount of operative memory
|
used_by_server
|
Amount of operative memory used by the Server
|
free
|
Amount of free operative memory
|
•The cluster block contains information on the Servers cluster. The cluster block elements:
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 repository block contains information on the Server repository. The repository block elements:
Attribute
|
Description
|
bytes_in
|
Number of received data in bytes
|
bytes_out
|
Number of sent data in bytes
|
files_added
|
Number of new files added
|
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 db block contains information on the Server database usage. The db block elements:
Attribute
|
Description
|
rows_read
|
Number of read rows
|
rows_written
|
Number of written rows
|
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 client block contains information on the clients connected to the Server. The client block elements:
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 Servers
|
newbies
|
Number of newbies
|
•The alert block contains information on the Server notifications. The alert block elements:
Attribute
|
Description
|
total
|
Total number of generated notifications
|
size
|
Total size of generated notifications
|
failed
|
Number of unsent notifications
|
sent
|
Number of successfully sent notifications
|
•The vm block contains information on a usage of system resources on the computer with the Server installed. The vm block elements:
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 read
|
write_cnt
|
Number of memory write
|
virtual_memory
|
Virtual memory currently allocated to the Server
|
threads
|
Number of running threads
|
working_set
|
Working set
|
|
