com.quantum.dxi.rest.dar

Class Rrd

java.lang.Object

Base

com.quantum.dxi.rest.dar.Rrd

public class Rrd
extends Base

The Rrd resource represents information about the RRD databases on the system. The Rrd interface includes services for getting RRD metadata from the databases, including database names, database data source names, supported consolidation functions, and supported resolutions. For getting actual data from RRD databases please refer to the RrdStats web service.

The schema that defines the Rrd resource is defined below.

 

    <xs:element name="Scalar" type="ScalarType"/>
    <xs:complexType name="ScalarType">
        <xs:sequence>
            <xs:element name="Name" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>

    <xs:element name="StringListScalar" type="StringListScalarType"/>
    <xs:complexType name="StringListScalarType">
        <xs:complexContent>
            <xs:extension base="ScalarType">
                <xs:sequence>
                    <xs:element name="Value" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
                </xs:sequence>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>

    <xs:element name="RrdArchive" type="RrdArchive"/>
    <xs:complexType name="RrdArchive">
        <xs:sequence>
            <xs:element name="ConsolidationFunction" type="xs:string"/>
            <xs:element name="Resolution" type="xs:string"/>
        </xs:sequence>
    </xs:complexType>

    <xs:element name="RrdArchives">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int"/>
                <xs:element ref="RrdArchive" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
Rrd()

Method Summary

Modifier and Type	Method and Description
RrdArchives	getArchives(javax.servlet.http.HttpServletRequest request, String database, String errorType) GET /rest/Rrd/Archives/{database}
StringListScalarType	getDatabases(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/Rrd
StringListScalarType	getDataSources(javax.servlet.http.HttpServletRequest request, String database, String errorType) GET /rest/Rrd/DataSources/{database}

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Rrd

public Rrd()

Method Detail

getDatabases

public StringListScalarType getDatabases(@Context
                                         javax.servlet.http.HttpServletRequest request,
                                         String errorType)

GET /rest/Rrd

Get the list of RRD database names on the system. These names are the list of valid values to use for the {database} path element for the /rest/RrdStats web services.

Response Entity type: <xs:element name="StringListScalarType">

Since:

1.1

See Also:

RrdStats

getDataSources

public StringListScalarType getDataSources(@Context
                                           javax.servlet.http.HttpServletRequest request,
                                           String database,
                                           String errorType)

GET /rest/Rrd/DataSources/{database}

Get the list of RRD data source names for a RRD database on the system. These names are the list of valid values to use for the {series} path element for the /rest/RrdStats web services, in conjunction with this {database} path element.

Response Entity type: <xs:element name="StringListScalarType">

Since:

1.1

See Also:

RrdStats

getArchives

public RrdArchives getArchives(@Context
                               javax.servlet.http.HttpServletRequest request,
                               String database,
                               String errorType)

GET /rest/Rrd/Archives/{database}

Get the list of RRD data archives for a RRD database on the system. An archive represents a consolidation function (CF) and data resolution available for a database. The CF and data resolution from a single archive should be used for the {function} and {resolution} path elements for the /rest/RrdStats web services, in conjunction with this {database} path element, to specify the data request.

Response Entity type: <xs:element name="RrdArchives">

Since:

1.1

See Also:

RrdStats