Cisco Cisco Videoscape Voyager Vantage 3.3 用户指南

REST APIs

Public REST API

Optional Parameters

format

“text”

Return information as formatted text. 
(Default)

“json”

Return information in JSON format.

datatype

“dbReplica”

JSON objects are constructed to 
match format in diagnostic screen 
database. (Default)

“smartConvert”

path

<text>

Text indicating page to be referenced 
by other parameters. Roughly, a 
directory path of the hierarchical OSD 
pages.

pagenum

<integer>

Diagnostic page number within a 
category or sub-category. If not 
specified, the default is all pages.

title

<text>

Selects diagnostic pages by title. If 
not specified, the default is all titles.

name

<module name>

Specifies the type of log file to return. 
Currently only dlog is used, but the 
JavaScript logging could use vod or 
similar. If not specified, the default is 
all logs.

begintime

<time-stamp>

If present, represents the oldest time 
stamp to return. This is useful to avoid 
retrieving duplicates if the caller 
keeps the newest time stamp from 
the last GET.

endtime

<time-stamp>

If present, represents the last time 
stamp to return. This is useful to limit 
the log messages to a certain period 
of time around a failure.

Each URL supports one or more of the following optional parameters.

REST Parameter

Value

Description

JSON objects are created for flexible 
random access of elements.

The paths are strict comparisons and 
are case-sensitive. The exact page 
names must be known by the client.

All logs are stored in a single file. This 
is a filter for transport.

Time is in UNIX standard seconds 
from the EPOCH, midnight Jan 1, 
1970 UTC.