Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Station identifier.
This parameter can be defined in the request several times to get the lists of currently running components for several stations at a time.
|
yes
|
Request Example
http://192.168.1.1:9080/api/stations/running-components.ds?id=30cc7eb2-d11d-b211-b695-b80815e63511
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1401789582" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<stations total="1">
<station id="30cc7eb2-d11d-b211-b695-b80815e63511">
<components total="1">
<component code="124" name="Dr.Web Self-protection" params="" started="1401816435" type="8" user="NT AUTHORITY\system"/>
</components>
</station>
</stations>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <stations /> element contains information on all requested stations. The <stations /> element attributes:
Attribute
|
Description
|
total
|
Total number of stations information on which the replay contains
|
▫The <station /> element contains information on a specific station. The <station /> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
•The <components /> element contains information on all currently running components of a specific station. The <components /> element attributes:
Attribute
|
Description
|
total
|
Total number of components which are running on this stations
|
▫The <component /> element contains information about a specific running component. The <component /> element attributes:
Attribute
|
Description
|
code
|
Digital code of the component. See the Component codes section
|
name
|
Component name. See the Component codes section
|
params
|
Component start parameters
|
started
|
Component start time in the UNIX timestamp format
|
type
|
Component starting method. May take one of the following values:
•1—manual start, •2—started by a scheduled task, •4—started by the user, •8—started as system process. |
user
|
Station user on behalf of which the component was launched
|
JSON Response Structure
{ "head": {
"status": true,
"timestamp":1410515538,
"api":{
"version":40103},
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "70c5f522-aaab-4c93-a180-a442a0da9c2a"}},
"data":{
"total": 1,
"list": [{
"components":[{
"type":8,
"name":"Dr.Web Self-protection",
"code":124,
"started_time":1410541860,
"user":"NT AUTHORITY\\SYSTEM",
"pid":"124",
"params":""
},{
"type":8,
"name":"Dr.Web Parental Control",
"code":54,
"started_time":1410541860,
"user":"NT AUTHORITY\\SYSTEM",
"pid":"54",
"params":""}],
"station_id":"if"}]}}
|
Description of JSON Response Parameters
The data block contains information on all stations.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations information on which the replay contains
|
•The list array contains information on specific stations. Elements in the list array block:
Field name
|
Description
|
station_id
|
Station Identifier
|
•The components block contains information on all currently running components of a station. Elements in the components array block:
Field name
|
Description
|
code
|
Digital code of the component. See the Component codes section
|
name
|
Component name. See the Component codes section
|
params
|
Component start parameters
|
started_time
|
Component start time in the UNIX timestamp format
|
type
|
Component starting method. May take one of the following values:
•1—manual start, •2—started by a scheduled task, •4—started by the user, •8—started as system process. |
user
|
Station user on behalf of which the component was launched
|
pid
|
Process identifier at the station
|
|