Find answers to commonly-asked questions about EdgeKV.
EdgeKV product features include:
- Key-Value database. Stores data in string or JSON format.
- Replicated storage. Ensures high availability of stored data by replicating it across multiple geographic locations.
- Administrative API. Enables control of EdgeKV database functions outside EdgeWorkers code.
- Tokenized access. Enforces access controls to EdgeKV databases.
The primary prerequisite for EdgeKV is the EdgeWorkers Dynamic Compute product on contract. EdgeWorkers itself requires an underlying Akamai delivery product. Refer to the EdgeWorkers limitations section for a complete list of supported delivery products.
If you're an Akamai customer interested in participating in the EdgeKV program, you can use the Marketplace app store to provision EdgeKV, or speak with your Akamai account representative. If you're not a current Akamai customer, submit a request using this form.
EdgeKV uses an eventual consistency model to achieve high availability.
First, make sure you have API credentials for a user at the top level group under your account. If you still get a failure, you can try calling the initialize API endpoint or CLI command again.
If initialization continues to fail, capture the API response or CLI command output. We'll also need the response from the
GET /edgekv/v1/initialize API or the output of the
edgekv show status CLI command to help debug the problem.
If this problem persists, contact Akamai support at email@example.com.
EdgeKV is an eventually consistent system. This means that there's a period of time (called the “inconsistency window”) when a write operation must propagate across the network to update that object. Before a read operation can be consistently completed against that object, this window of time must expire. This period of time is 10 seconds or less in the majority of cases.
Groups can only be created in tandem with the creation of an item to store in that group. They cannot be directly created. A group is automatically created for you if it doesn't already exist when using an API call or a CLI command.
EdgeKV stores data as unstructured text objects that are not strongly typed. Please specify the data return format using the
getJSON() library helper method. Akamai automatically transforms text into a JSON object.
There are two sets of credentials that can be used for EdgeKV. The token created in Akamai Control Center (“EdgeGrid”) is only used for making calls against the Administrative API. The other token, the EdgeKV access token, is included in the EdgeWorkers code bundle to control access to an EdgeKV namespace.
If you receive an error indicating that, “The client does not have the grant needed for the request,” your API client is missing the required READ-WRITE access level. For instructions on how to add it, refer to the Get started section in the EdgeKV API documentation.
Updated about a month ago