Cisco Cisco Videoscape Voyager Vantage 3.2 用户指南

REST APIs

Public REST API

Combining Parameters

To combine selection parameters, use the ampersand (&) to represent a logical AND. For example:

This API combines two query parameters:



category=DOCSIS%20STATUS



title=IP%DIRECT%FILTERS

This API returns all pages in the category “DOCSIS STATUS” with the title “IP DIRECT FILTERS.”

 Combining selection parameters reduces network traffic at some expense to set-top CPUs. All log records are 

stored in a single flat file, and each record in the file must be parsed for selection.

Usage

Following are examples of complete Public REST API calls.

Returns all diagnostic pages in text form. Similar to the output of resdiag SilentDiag.

Returns all diagnostic subpages with the title “DOCSIS Events” in JSON format.

Returns the first page navigating down through two subcategories.

Returns the DLOG messages collected at the designated time based on the diagnostics.ini file from the private interface.

 The message file is not filtered by default. Duplicate messages can be retrieved and filtered by the client by time 

stamp or by using the optional begintime and endtime filters. In this example, begintime is UNIX time for May 29, 2015 
at 4:12:40 PM EDT.

Returns the VOD messages generated by JavaScript applications that use the vod name in the private interface. No such 
files exist at the time of writing.

HTTP Status Codes

When used, the Public REST API may return any of the following status codes:



: Successful request



: Bad Request

A parameter or its value was not recognized, or the query was otherwise malformed.



: Not Found

The URL path is invalid.