In many cases, diagnostic data can't be pre-cached, and Akamai edge servers need to dynamically assemble it for you. This introduces significant latencies when performing some requests. Requests can run minutes long, and can time out. To address this problem, the CAM API addresses data asynchronously with some of its operations. The initial response to these operations contains the requestId
and retryAfter
objects. You also get a response header that includes the Location
and Retry-After
values. For example, a successful request to create a new access key returns these components:
The response body
{
"requestId": 195,
"retryAfter": 4
}
The response headers
Location:/cam/v1/access-key-create-requests/6477
Retry-After: 4
Use this data in a later request to poll the status of the initial request. You can use the requestId
from the response to check status, but you should wait the retryAfter
number of seconds before you do. Additionally, you can use the Location
path from the response header as a Hypermedia link in a GET operation. You should also wait the Retry-After
number of seconds.
The API provides this set of asynchronous operations:
POST async request | GET request status |
---|---|
Create an access key | Get the status of an access key job |
Create an access key version | Get the status of an access key version job |
Some operations work differently
There are other operations in this API that address data asynchronously but work differently. See these resources' specific entries to see if you need to apply a different method: