deliveryservices/{{ID}}/health

See also

Health Protocol

GET

Retrieves the health of all Cache Groups assigned to a particular Delivery Service

Auth. Required

Yes

Roles Required

None1

Permissions Required

DELIVERY-SERVICE:READ, CACHE-GROUP:READ

Response Type

Object

Request Structure

Table 312 Request Path Parameters

Name

Description

ID

The integral, unique identifier of the Delivery service for which Cache Groups will be displayed

Response Structure

cachegroups

An array of objects that represent the health of each Cache Group assigned to this Delivery Service

name

A string that is the name of the Cache Group represented by this object

offline

The number of OFFLINE cache servers within this Cache Group

online

The number of ONLINE cache servers within this Cache Group

totalOffline

Total number of OFFLINE cache servers assigned to this Delivery Service

totalOnline

Total number of ONLINE cache servers assigned to this Delivery Service

#748 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: Thu, 15 Nov 2018 14:43:43 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: KpXViXeAgch58ueQqdyU8NuINBw1EUedE6Rv2ewcLUajJp6kowdbVynpwW7XiSvAyHdtClIOuT3OkhIimghzSA==
Content-Length: 115

{ "response": {
    "totalOffline": 0,
    "totalOnline": 1,
    "cachegroups": [
        {
            "offline": 0,
            "name": "CDN_in_a_Box_Edge",
            "online": 1
        }
    ]
}}
1

Users will only be able to see Cache Group health details for the Delivery Services their Tenant is allowed to see.