Billhighway Cloud API

<back to all web services

CacheStatsRq

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

// @Flags()
export enum CacheResult
{
    None = 0,
    Miss = 1,
    Hit = 2,
    Put = 4,
    Deleted = 8,
    Cleared = 16,
    Added = 32,
    Updated = 64,
    Unavailable = 128,
    Expired = 256,
}

export enum CacheLocation
{
    None = 0,
    OutOfProcess = 1,
    InProcess = 2,
    InContext = 3,
}

export class CacheKey
{
    public Region?: string;
    public BaseKey?: string;
    public Key?: string;
    public ExpirationSeconds?: number;

    public constructor(init?: Partial<CacheKey>) { (Object as any).assign(this, init); }
}

export class CacheResultBase
{
    public Result?: CacheResult;
    public Location?: CacheLocation;
    public Key?: CacheKey;

    public constructor(init?: Partial<CacheResultBase>) { (Object as any).assign(this, init); }
}

export class CacheStat
{
    public Name?: string;
    public Value?: string;

    public constructor(init?: Partial<CacheStat>) { (Object as any).assign(this, init); }
}

export class CacheStatResult extends CacheResultBase
{
    public Statistics?: CacheStat[];
    public IsHit?: boolean;

    public constructor(init?: Partial<CacheStatResult>) { super(init); (Object as any).assign(this, init); }
}

export class CacheStatsRs
{
    public Statistics?: CacheStatResult;

    public constructor(init?: Partial<CacheStatsRs>) { (Object as any).assign(this, init); }
}

export class CacheStatsRq
{
    public location?: string;

    public constructor(init?: Partial<CacheStatsRq>) { (Object as any).assign(this, init); }
}

TypeScript CacheStatsRq DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Statistics: 
	{
		Statistics: 
		[
			{
				Name: String,
				Value: String
			}
		],
		IsHit: False,
		Result: 0,
		Location: 0
	}
}