caches/stats

An API endpoint that returns cache statistics using the Traffic Monitor APIs.

See also

This gives a set of basic statistics for all cache servers at the current time. For statistics from time ranges and/or aggregated over a specific CDN, use cache_stats.

GET

Retrieves cache stats from Traffic Monitor. Also includes rows for aggregates.

Auth. Required:

Yes

Roles Required:

None

Permissions Required:

CACHE-GROUP:READ, PROFILE:READ

Response Type:

Array

Request Structure

No parameters available.

Response Structure

cachegroup:

A string that is the Name of the Cache Group to which this cache server belongs

connections:

Current number of TCP connections maintained by the cache server

healthy:

true if Traffic Monitor has marked the cache server as “healthy”, false otherwise

See also

Health Protocol

hostname:

The (short) hostname of the cache server

ip:

The IP address of the cache server

kbps:

The cache server’s upload speed (to clients) in Kilobits per second

profile:

The Name of the Profile in use by this cache server

status:

The status of the cache server

#1136 Response Example

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Content-Type: application/json
Date: Wed, 14 Nov 2018 20:25:01 GMT
X-Server-Name: traffic_ops_golang/
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Vary: Accept-Encoding
Whole-Content-Sha512: DqbLgitanS8q81/qKC1i+ImMiEMF+SW4G9rb79FWdeWcgwFjL810tlTRp1nNNfHV+tajgjyK+wMHobqVyaNEfA==
Content-Length: 133

{ "response": [
    {
        "profile": "ALL",
        "connections": 0,
        "ip": null,
        "status": "ALL",
        "healthy": true,
        "kbps": 0,
        "hostname": "ALL",
        "cachegroup": "ALL"
    }
]}