Submit load data

post

http://{hostname}/gtm-load-data/v1/{domain}/{resource}/{datacenterId}

Use this action to submit load data. The URL specifies the domain, resource, and datacenterId of the instance to which the load data pertains. The data may be submitted in either XML or JSON format. To support legacy clients, we allow region as an alias for datacenterId. The timestamp string should be in XSD format.

Path Params

domain

string

required

The name of the GTM domain.

resource

string

required

The name of the resource.

datacenterId

integer

required

The ID number for the datacenter (traffic target), from the "Akamai code" field in Control Center.

Body Params

Provides information that you need to specify when submitting load data for a GTM domain.

domain

string

required

The name of the domain being updated, such as example.akadns.net.

datacenterId

integer

required

The number of the datacenter (traffic target) being updated. This number comes from the Akamai code field in Control Center. To support legacy clients, we accept region as an alias for datacenterId.

resource

string

required

The name of the resource that is being used to balance load. This can be any quantity you define. For example, a resource can represent connections to a database, bandwidth, hits, or anything else.

current-load

integer

required

The current load on the resource in the given datacenter. For example, if the resource is database connections, and you have 50 connections, you would report 50 for this value.

target-load

integer

required

GTM's load balancer begins to shift traffic away from a traffic target when the current-load exceeds the target-load. For example, if you want traffic to begin shifting away from a database location when it has 100 connections, you would set the target-load to 100.

max-load

integer

required

If the load in every datacenter exceeds its target, GTM raises targets proportional to the difference between max-load and target-load. Set max-load higher in data centers that can handle more traffic when the whole system is overloaded.

timestamp

string

required

This should be the time at which the load was recorded, in XSD date format.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

204

Status 204

400Missing mandatory API parameters.

403The user specified has no entitlement to access data for the domain, resource, and datacenter.

405Method is forbidden (only GET or POST allowed).

429Too many requests. The user has sent too many requests in a given amount of time.

500Internal server error.