Skip to content

Latest commit

 

History

History
193 lines (163 loc) · 9.09 KB

cachegroups_id.rst

File metadata and controls

193 lines (163 loc) · 9.09 KB
Raw

cachegroups/{{ID}}

PUT

Update Cache Group

Auth. Required

Yes

Roles Required

"admin" or "operations"

Response Type

Object

Request Structure

Request Path Parameters
Parameter Description
ID The cache-group-id of a Cache Group
fallbacks

An optional field which, when present, should contain an array of strings that are the Names <cache-group-name> of other Cache Groups which will be the cache-group-fallbacks1

fallbackToClosest

A boolean that sets the cache-group-fallback-to-closest behavior of the Cache Group2

Note

The default value of fallbackToClosest is true, and if it is null Traffic Control components will still interpret it as though it were true.

latitude

An optional field which, if present, should be a floating-point number that will define the cache-group-latitude for the Cache Group3

localizationMethods

Array of cache-group-localization-methods (as strings)

Tip

This field has no defined meaning if the cache-group-type identified by typeId is not "EDGE_LOC".

longitude

An optional field which, if present, should be a floating-point number that will define the cache-group-longitude for the Cache Group4

name

The cache-group-name of the Cache Group

parentCachegroupId

An optional field which, if present, should be an integer that is the cache-group-id of a cache-group-parent for this Cache Group.

secondaryParentCachegroupId

An optional field which, if present, should be an integral, unique identifier for this Cache Group's secondary parent

shortName

An abbreviation of the name

typeId

An integral, unique identifier for the Cache Group's Type <cache-group-type>

Note

The actual, integral, unique identifiers for these Types must first be obtained, generally via to-api-v3-types.

PUT /api/3.0/cachegroups/8 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...
Content-Length: 118
Content-Type: application/json

{
    "latitude": 0.0,
    "longitude": 0.0,
    "name": "test",
    "fallbacks": [],
    "fallbackToClosest": true,
    "shortName": "test",
    "typeId": 23,
    "localizationMethods": ["GEO"]
}

Response Structure

fallbacks

An array of strings that are Cache Group names <cache-group-name> that are registered as cache-group-fallbacks for this Cache Group5

fallbackToClosest

A boolean value that defines the cache-group-fallback-to-closest behavior of this Cache Group6

id

An integer that is the cache-group-id of the Cache Group

lastUpdated

The time and date at which this entry was last updated in non-rfc-datetime

latitude

A floating-point cache-group-latitude for the Cache Group

localizationMethods

An array of cache-group-localization-methods as strings

longitude

A floating-point cache-group-longitude for the Cache Group

name

A string containing the cache-group-name of the Cache Group

parentCachegroupId

An integer that is the cache-group-id of this Cache Group's cache-group-parent - or null if it doesn't have a cache-group-parent

parentCachegroupName

A string containing the cache-group-name of this Cache Group's cache-group-parent - or null if it doesn't have a cache-group-parent

secondaryParentCachegroupId

An integer that is the cache-group-id of this Cache Group's cache-group-secondary-parent - or null if it doesn't have a cache-group-secondary-parent

secondaryParentCachegroupName

A string containing the cache-group-name of this Cache Group's cache-group-secondary-parent Cache Group - or null if it doesn't have a cache-group-secondary-parent

shortName

A string containing the cache-group-short-name of the Cache Group

typeId

An integral, unique identifier for the 'Type' of the Cache Group

typeName

A string that names the cache-group-type of this Cache Group

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: t1W65/2kj25QyHt0Ib0xpBaAR2sXu2kOsRZ49WjKZp/AK5S1YWhX7VNWCuUGiN1VNM4QRNqODC/7ewhYDFUncA==
X-Server-Name: traffic_ops_golang/
Date: Wed, 14 Nov 2018 19:14:28 GMT
Content-Length: 385

{ "alerts": [
    {
        "text": "cachegroup was updated.",
        "level": "success"
    }
],
"response": {
    "id": 8,
    "name": "test",
    "shortName": "test",
    "latitude": 0,
    "longitude": 0,
    "parentCachegroupName": null,
    "parentCachegroupId": null,
    "secondaryParentCachegroupName": null,
    "secondaryParentCachegroupId": null,
    "fallbacks": [],
    "fallbackToClosest": true,
    "localizationMethods": [
        "GEO"
    ],
    "typeName": "EDGE_LOC",
    "typeId": 23,
    "lastUpdated": "2018-11-14 19:14:28+00"
}}

DELETE

Delete a Cache Group. A Cache Group which has assigned servers or is the cache-group-parent of one or more other Cache Groups cannot be deleted.

Auth. Required

Yes

Roles Required

"admin" or "operations"

Response Type

undefined

Request Structure

Request Path Parameters
Parameter Description
ID The cache-group-id of a Cache Group to be deleted 
DELETE /api/3.0/cachegroups/42 HTTP/1.1
Host: trafficops.infra.ciab.test
User-Agent: curl/7.47.0
Accept: */*
Cookie: mojolicious=...

Response Structure

HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 18 Nov 2019 17:40:54 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: 5jZBgO7h1eNF70J/cmlbi3Hf9KJPx+WLMblH/pSKF3FWb/10GUHIN35ZOB+lN5LZYCkmk3izGbTFkiruG8I41Q==
X-Server-Name: traffic_ops_golang/
Date: Wed, 14 Nov 2018 20:31:04 GMT
Content-Length: 57

{ "alerts": [
    {
        "text": "cachegroup was deleted.",
        "level": "success"
    }
]}

  1. Traffic Router will first check for a fallbacks array and, when that is empty/unset/all the Cache Groups in it are also unavailable, will subsequently check for fallbackToClosest. If that is true, then it falls back to the geographically closest Cache Group capable of serving the same content or, when it is false/no such Cache Group exists/said Cache Group is also unavailable, will respond to clients with a failure response indicating the problem.↩

  2. Traffic Router will first check for a fallbacks array and, when that is empty/unset/all the Cache Groups in it are also unavailable, will subsequently check for fallbackToClosest. If that is true, then it falls back to the geographically closest Cache Group capable of serving the same content or, when it is false/no such Cache Group exists/said Cache Group is also unavailable, will respond to clients with a failure response indicating the problem.↩

  3. While these fields are technically optional, note that if they are not specified many things may break. For this reason, Traffic Portal requires them when creating or editing Cache Groups.↩

  4. While these fields are technically optional, note that if they are not specified many things may break. For this reason, Traffic Portal requires them when creating or editing Cache Groups.↩

  5. Traffic Router will first check for a fallbacks array and, when that is empty/unset/all the Cache Groups in it are also unavailable, will subsequently check for fallbackToClosest. If that is true, then it falls back to the geographically closest Cache Group capable of serving the same content or, when it is false/no such Cache Group exists/said Cache Group is also unavailable, will respond to clients with a failure response indicating the problem.↩

  6. Traffic Router will first check for a fallbacks array and, when that is empty/unset/all the Cache Groups in it are also unavailable, will subsequently check for fallbackToClosest. If that is true, then it falls back to the geographically closest Cache Group capable of serving the same content or, when it is false/no such Cache Group exists/said Cache Group is also unavailable, will respond to clients with a failure response indicating the problem.↩