Get Active Services

This URL gets the list of active services.

Resource URL

GET /ntbamonitors/{ntbaId}/activeservices? TopN=<TopN> &timePeriod=<timePeriod>&startTime=<startTime>&endTime=<endTime>

Request Parameters


Field Name	Description	Data Type	Mandatory
`ntbaId`	NTBA monitor id	Number	Yes
`TopN`	Number of top rows, default 50.	Number	No
`timePeriod`	Duration: can be LAST_MINUTE LAST_10_MINUTES LAST_HOUR LAST_24_HOURS CUSTOM Custom incase start and end time is provided	String	No
`startTime`	Start time in the format: yyyy-MM-dd HH:mm	String	No
`endTime`	End time in the format: yyyy-MM-dd HH:mm	String	No

Response Parameters

Following fields are returned if the request parameters are correct, otherwise error details are returned.


Field Name	Description	Data Type
`services`	List of services	Array

Details of services:


Field Name	Description	Data Type
`service`	Service name	String
`serviceId`	Service id	Number
`protocol`	Protocol	String
`lastSeen`	Last seen	String

Example

Request

GET https://%3CNSM_IP%3E/sdkapi/ntbamonitors/1006/activeservices?timePeriod=CUSTOM&startTime=2012-APR-20%2012:15&endTime=2012-APR-20%2012:11

Response

{
  “services”:[{
         “service”:”Unprofiled”,
         “serviceId”:0,
         “protocol”:”ipv4”,
          “lastSeen”:”2013-08-27 16:44:06”
           }]
}

Error Information

Following error codes are returned by this URL:


S.No	HTTP Error Code	SDK API errorId	SDK API errorMessage
1	400	4301	Invalid duration
2	400	4302	Invalid time format
3	400	4303	Start time is greater than end time
4	400	4304	Invalid date format
5	400	4305	Start/End date is not provided
6	400	4306	Invalid NTBA id