Skip to content

Latest commit

 

History

History
90 lines (76 loc) · 3.01 KB

cdns_name_health.rst

File metadata and controls

90 lines (76 loc) · 3.01 KB
Raw

cdns/{{name}}/health

GET

Retrieves the health of all :term:`Cache Groups` for a given CDN.

Auth. Required:Yes
Roles Required:None
Permissions Required:CDN:READ, CACHE-GROUP:READ
Response Type:Object

Request Structure

Request Path Parameters
Name Description
name The name of the CDN for which health will be reported 
GET /api/5.0/cdns/CDN-in-a-Box/health HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...

Response Structure

cachegroups:

An array of objects describing the health of each :term:`Cache Group`

name:A string that is the :ref:`Cache Group's Name <cache-group-name>`
offline:The number of OFFLINE :term:`cache servers` in the :term:`Cache Group`
online:The number of ONLINE :term:`cache servers` in the :term:`Cache Group`
totalOffline:

Total number of OFFLINE :term:`cache servers` across all :term:`Cache Groups` which are assigned to the CDN defined by the name request path parameter
totalOnline:

Total number of ONLINE :term:`cache servers` across all :term:`Cache Groups` which are assigned to the CDN defined by the name request path parameter

 
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-Encoding: gzip
Content-Length: 108
Content-Type: application/json
Date: Tue, 03 Dec 2019 21:33:59 GMT
X-Server-Name: traffic_ops_golang/
Set-Cookie: mojolicious=...; expires=Wed, 04 Dec 2019 01:33:59 GMT; path=/; HttpOnly
Vary: Accept-Encoding
Whole-Content-Sha512: KpXViXeAgch58ueQqdyU8NuINBw1EUedE6Rv2ewcLUajJp6kowdbVynpwW7XiSvAyHdtClIOuT3OkhIimghzSA==

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