OpenAPI enables you to manage Ultipa clusters without logging into Ultipa Cloud.

This article introduces OpenAPI-cluster for operating Graph Powerhouse clusters in Ultipa Cloud.

API Overview

Base URL

The base URL of OpenAPI-cluster is https://cloud.ultipa.com/open/dbaas/v1/cluster/.

API Keys

API Keys are used to initiate an API request.

On Accounts of Ultipa Cloud, scroll down to API Keys to create or manage your API keys. Remember to download your API key for later usage.

One API key should be included in each request header, with the key name as api_key.

List Clusters

HTTP Request

To list clusters, submit a GET request to the following endpoint:

https://cloud.ultipa.com/open/dbaas/v1/cluster/list

Request Header

Request Parameters

Request Example

GET https://cloud.ultipa.com/open/dbaas/v1/cluster/list??page=1&size=20&instanceStateFilter=1&directions=desc&sorts=created_at&componentType=GRAPH_V5`
Authorization: Bearer api_key:{Your Ultipa Cloud API key}
Accept: application/json

Response Example

{
    "code": 200,
    "message": "success",
    "data": {
        "page": 1,
        "size": 20,
        "totalPages": 1,
        "totalElements": 2,
        "list": [
            {
                "clusterId": "ultipa-abc123",
                "clusterState": "STOPPING",
                "name": "test2",
                "instanceList": [
                    {
                        "name": "xxxxxxxx_NAME_SERVER-1",
                        "instanceState": "STOPPING",
                        "type": "Name server"
                    },
                    {
                        "name": "xxxxxxxx_META_SERVER-1",
                        "instanceState": "STOPPING",
                        "type": "Meta server"
                    },
                    {
                        "name": "xxxxxxxx_SHARD_SERVER-1-1",
                        "instanceState": "STOPPING",
                        "type": "Shard server"
                    }
                ]
            },
            {
                "clusterId": "ultipa-abc456",
                "clusterState": "STOPPING",
                "name": "Graph Powerhouse 0",
                "instanceList": [
                    {
                        "name": "xxxxxxxxxxxx_NAME_SERVER-1",
                        "instanceState": "STOPPING",
                        "type": "Name server"
                    },
                    {
                        "name": "xxxxxxxxxxxx_META_SERVER-1",
                        "instanceState": "STOPPING",
                        "type": "Meta server"
                    },
                    {
                        "name": "xxxxxxxxxxxx_SHARD_SERVER-1-1",
                        "instanceState": "STOPPING",
                        "type": "Shard server"
                    }
                ]
            }
        ]
    }
}

View Cluster State

HTTP Request

To view the state of a cluster, submit a POST request to the following endpoint:

https://cloud.ultipa.com/open/dbaas/v1/cluster/state

Request Header

Request Body

{
    "clusterIds": ["ultipa-abc123", "ultipa-abc456"]
}

Request Example

POST https://cloud.ultipa.com/open/dbaas/v1/cluster/state
Authorization: Bearer api_key:{Your Ultipa Cloud API key}
Content-Type: application/json

{
  "clusterIds": [
    "ultipa-abc123",
    "ultipa-abc456"
  ]
}

Response Example

{
    "code": 200,
    "message": "success",
    "data": [
        {
            "clusterId": "ultipa-abc123",
            "clusterState": "STOPPING",
            "name": "test2",
            "instanceList": [
                {
                    "name": "xxxxxxxxxxxxxxxxx_NAME_SERVER-1",
                    "instanceState": "STOPPING",
                    "type": "Name server"
                },
                {
                    "name": "xxxxxxxxxxxxxxxxx_META_SERVER-1",
                    "instanceState": "STOPPING",
                    "type": "Meta server"
                },
                {
                    "name": "xxxxxxxxxxxxxxxxxs_SHARD_SERVER-1-1",
                    "instanceState": "STOPPING",
                    "type": "Shard server"
                }
            ]
        },
        {
            "clusterId": "ultipa-abc456",
            "clusterState": "STOPPING",
            "name": "Graph Powerhouse 0",
            "instanceList": [
                {
                    "name": "xxxxxxxxxxxxxyyyyyy_NAME_SERVER-1",
                    "instanceState": "STOPPING",
                    "type": "Name server"
                },
                {
                    "name": "xxxxxxxxxxxxxyyyyyy_META_SERVER-1",
                    "instanceState": "STOPPING",
                    "type": "Meta server"
                },
                {
                    "name": "xxxxxxxxxxxxxyyyyyy_SHARD_SERVER-1-1",
                    "instanceState": "STOPPING",
                    "type": "Shard server"
                }
            ]
        }
    ]
}

Start a Cluster

HTTP Request

To start a cluster, submit a POST request to the following endpoint:

https://cloud.ultipa.com/open/dbaas/v1/cluster/start

Request Header

Request Body

{
    "clusterId": "ultipa-abc123"
}

Request Example

POST https://cloud.ultipa.com/open/dbaas/v1/cluster/start
Authorization: Bearer api_key:{Your Ultipa Cloud API key}
Content-Type: application/json

{
    "clusterId": "ultipa-abc123"
}

Response Example

{
    "code": 200,
    "message": "success",
    "data": null
}

Stop a Cluster

HTTP Request

To stop a cluster, submit a POST request to the following endpoint:

https://cloud.ultipa.com/open/dbaas/v1/cluster/stop

Request Header

Request Body

{
    "clusterId": "ultipa-abc123"
}

Request Example

POST https://cloud.ultipa.com/open/dbaas/v1/cluster/stop
Authorization: Bearer api_key:{Your Ultipa Cloud API key}
Content-Type: application/json

{
    "clusterId": "ultipa-abc123"
}

Response Example

{
    "code": 200,
    "message": "success",
    "data": null
}

Response Error Codes