This table aggregates membership for all versions of the Datacenter object.
Versioned schema members
Any object member specific to a range of versions is indicated in its description, at what version the member was either introduced or removed. Any listed data member with no version number is common to all versions of the object.
Member | Type | Description |
---|---|---|
Datacenter : Contains information about the data centers in the GTM domain. | ||
city | String, Null | The name of the city where the data center is located. |
cloneOf | Integer, Null | Identifies the data center's datacenterId of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes continent , country , stateOrProvince , city , latitude , and longitude from the data center of which it is a clone. |
cloudServerHostHeaderOverride | Boolean | Balances load between two or more servers in a cloud environment. Either true if cloud server targeting is enabled or false if not. |
cloudServerTargeting | Boolean | Balances load between two or more servers in a cloud environment. Either true if cloud server targeting is enabled or false if not. |
continent | Enumeration, Null | A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this member. Either AF , AS , EU , NA , OC , OT , or SA . |
country | String, Null | A two-letter ISO 3166 country code that specifies the country where the data center maps to. |
datacenterId | Integer | A unique identifier for an existing data center in the domain. |
defaultLoadObject | Datacenter.defaultLoadObject | Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual Resource objects can specify useDefaultLoadObject to use it instead of specifying their own. |
latitude | Number | Specifies the geographical latitude of the data center's position. See also longitude within this object. |
links | Hypermedia | Provides a URL path that allows direct navigation to a data center. |
longitude | Number | Specifies the geographic longitude of the data center's position. See also latitude within this object. |
nickname | String | A descriptive label for the data center. |
scorePenalty | Integer | Influences the score for a datacenter. Giving a positive penalty increases the score and drives traffic away from the datacenter. Giving a negative penalty reduces the score and draws in more traffic that would otherwise go elsewhere. As the score is measured in milliseconds of ping time, very small numbers like 1 or 2 have virtually no effect. Typically, penalties are given in the tens or hundreds. Note that scorePenalty applies only for properties that use performance load balancing. |
stateOrProvince | String, Null | Specifies a two-letter ISO 3166 country code for the state or province where the data center is located. |
virtual | Boolean | Read-only. Indicates whether or not the data center is virtual or physical, the latter meaning the data center has an Akamai Network Agent installed, and its physical location in latitude and longitude is fixed. Either true if virtual or false if physical. |
Datacenter.defaultLoadObject : Specifies the load reporting interface between you and the GTM system. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. This default load object is intended to be shared. Individual Resource objects can specify useDefaultLoadObject to use it instead of specifying their own. | ||
loadObject | String | Specifies the load object that GTM requests. A load object is a file that provides real-time information about the current load, maximum allowable load, and target load on each resource. The value cannot begin with a : character, and is limited to a maximum of 256 characters. |
loadObjectPort | Integer | Specifies the TCP port to connect to when requesting the load object. A value of 0 means to use the default port, equivalent to either 80 or 443 . |
loadServers | Array | Specifies a list of servers to request the load object from. The value needs to contain IPv4 or IPv6 addresses, or DNS names that contain A or AAAA records. If a DNS name has both A and AAAA records, then GTM picks one randomly. For IP addresses, don't use non-routable RFC 1918 addresses. |
Sample v1 object
This version contains information about the data centers in the GTM domain. It uses this MIME type:
datacenter-vnd-config-gtm.v1.0+json
{
"city": "Downpatrick",
"cloneOf": 0,
"continent": "EU",
"country": "GB",
"datacenterId": 3133,
"latitude": 54.367,
"longitude": -5.582,
"nickname": "Winterfell",
"stateOrProvince": null,
"virtual": true,
"defaultLoadObject": {
"loadObject": null,
"loadObjectPort": 0,
"loadServers": null
},
"links": [
{
"href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133",
"rel": "self"
}
]
}