Get VMS Information Lists

Return VMS information.

 

 

GET /media/vmsInfo?token=[PublicAccessToken]

Parameters

Name

Type

Description

Name

Type

Description

PublicAccessToken

String

(required)Public access token

name

String

(optional) returns comma separated VMS objects by their name(s)

 

Note: Wizeye site should have Public Access enabled (Settings > Configuration > Public Access > On)

 

 

Example Response

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 { "VMS hash name with 'vms' prefix": { "name": "VMS hash name with 'vms' prefix", "description": "", "label": "", "mediaserver": null, "status": "VMS Status", "mediaLink": null, "properties": { "ip": "VMS ip address", "vmstype": "VMS type", "status": "VMS Status", "detailed_status": "VMS & MD detailed status information" }, "metrics": null } }

Remarks

The table below shows descriptions on VMS status response that describes connection status between MediaServer(s) and VMS.

Status

Description

Status

Description

“connected”

MD<->VMS connection is connected and in normal state

“unavailable”

No response from MD

“error”

Sent signal to VMS but connection problems is appeared

“unknown”

Anything else (No response, etc.)

 

VMS types:

  • hikvision

  • ciscovsm7

  • mirasys (no supported yet)

 

Detailed status provide more information about each MD<-->VMS connection in detail.

Detailed Status

Description

Example, [MD name]:[VMS status]

Detailed Status

Description

Example, [MD name]:[VMS status]

“connected”

MD<->VMS connection is connected and in normal state

“MD1:connected”

“unavailable”

No response from MD

“MD1:unavailable”

“error (authentication failed)”

Sent signal to VMS but connection problems is appeared

“MD1:error (authentication failed)”

“unknown”

Anything else (No response, etc.)

“MD1:unknown”

Example response

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 { "vms-1434085181": { "name": "vms-1434085181", "description": "", "label": "", "mediaserver": null, "status": "unknown", "mediaLink": null, "properties": { "ip": "172.16.10.100:443", "vmstype": "hikvision", "status": "unknown", "detailed_status": "MD60:connected,MD87_dhseo:unavailable,md68:unavailable" }, "metrics": null } }

 

In case, if some of the Media Servers has connection problems with VMS (not all MD servers), then the result status will be “uknown”, otherwise it will show proper status as shown in table.