Connecting With REST

GridGain Cloud supports JDBC and ODBC connectivity as well as REST protocol and thin clients. These APIs make it possible to use the managed offering for distributed SQL database and key-value store scenarios.

The managed service goes with GridGain Client Cloud Pack and is also fully compatible with GridGain Community, Enterprise, and Ultimate Editions:

Using the REST API, you can communicate with your cluster running on GridGain Cloud, over HTTP protocol, and perform various operations. To do so, obtain the REST connection string from the Cluster Info screen like the one below:

When providing the REST connection string in the browser for the first time, you may see a security warning - "Your connection is not private". This is because the SSL is a self-signed certificate that needs to be manually installed. See here for more information.

Next, when connecting to the cluster on GridGain Cloud, you can request user authorization by providing user=[user]&password=[password] parameters in the REST connection string. Doing so will provide you with a session token that can be used with any command within that session. There are two ways to request authorization:

In both the examples above, replace [host], [port], [user] and [password] values with actual values provided in the Cluster Info.

Executing any one of the above strings in a browser will provide a response with a session token which will look something like this:

Once you obtain the session token, use the sessionToken parameter with your connection string as shown in the example below:

Now as an example, lets create a cache, and put and get some data, using REST.

To create a cache in the cluster using REST, run the following command in your browser:

Once the cache is created, we can put data in the cache, like so:

Similarly, to get the data from cache, the REST command would look like as follows:

The REST API also provides support for Java built-in types for put/get operations via keyType and valueType optional parameters. Note that unless one of the below mentioned types are explicitly specified, the REST protocol will exchange the key-value data in String format. This means that the data will be stored and retrieved to/from the cluster as a String.

The following example shows how to use the put command with keyType=int and valueType=date:

Similarly, the get command with keyType=int and valueType=date would be:

For more REST protocol commands, see the REST API documentation.