Billhighway Cloud API

<back to all web services

CacheStatsRq

The following routes are available for this service:
GET/devops/api/caches/{location}/stats
namespace BH.Caching

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<Flags>]
    type CacheResult =
        | None = 0
        | Miss = 1
        | Hit = 2
        | Put = 4
        | Deleted = 8
        | Cleared = 16
        | Added = 32
        | Updated = 64
        | Unavailable = 128
        | Expired = 256

    type CacheLocation =
        | None = 0
        | OutOfProcess = 1
        | InProcess = 2
        | InContext = 3

    [<AllowNullLiteral>]
    type CacheKey() = 
        member val Region:String = null with get,set
        member val BaseKey:String = null with get,set
        member val Key:String = null with get,set
        member val ExpirationSeconds:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CacheResultBase() = 
        member val Result:CacheResult = new CacheResult() with get,set
        member val Location:CacheLocation = new CacheLocation() with get,set
        member val Key:CacheKey = null with get,set

    [<AllowNullLiteral>]
    type CacheStat() = 
        member val Name:String = null with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type CacheStatResult() = 
        inherit CacheResultBase()
        member val Statistics:ResizeArray<CacheStat> = new ResizeArray<CacheStat>() with get,set
        member val IsHit:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CacheStatsRs() = 
        member val Statistics:CacheStatResult = null with get,set

    [<AllowNullLiteral>]
    type CacheStatsRq() = 
        member val location:String = null with get,set

F# CacheStatsRq DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /devops/api/caches/{location}/stats HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CacheStatsRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Caching.Api.Response">
  <Statistics xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.Caching">
    <d2p1:Key i:nil="true" />
    <d2p1:Location>None</d2p1:Location>
    <d2p1:Result>None</d2p1:Result>
    <d2p1:Statistics>
      <d2p1:CacheStat>
        <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
        <d2p1:_x003C_Value_x003E_k__BackingField>String</d2p1:_x003C_Value_x003E_k__BackingField>
      </d2p1:CacheStat>
    </d2p1:Statistics>
  </Statistics>
</CacheStatsRs>