ClustersHistorical API

Use the ClustersHistorical API to obtain a previous configuration for a cluster. Each time a cluster configuration changes, the cluster version number is incremented. You can access cluster information from previous cluster states using this resource version number.

Find the resource version in the resourceVersion field of a ClusterStatus object.

All URIs are relative to https://{vanity_domain}.implycloud.com/api/v1

Get cluster by version

URL

GET /clusters/{clusterId}/history/{resourceVersion}

Parameters

Path parameters

• clusterId   type: String   required
  The cluster ID

• resourceVersion   type: Integer   required
  A unique incrementing version number of the configuration of the cluster. Minimum value: 0.

Responses

A successful request returns an HTTP 2XX status code and a JSON response body of type Cluster.

200 SUCCESS

401 ERROR

404 ERROR

Successfully retrieved cluster configuration.

---

Unauthorized.

Example body:

{
  "error" : {
    "code" : "Unauthorized",
    "message" : "Provided user does not have permissions to complete this request"
  }
}

---

Not found.

Example body:

{
  "error" : {
    "code" : "NotFound",
    "message" : "Cluster [e9e1e18f-a9e8-4dd7-8a18-768039c57f22] resource version [2] was not found"
  }
}

---

Sample request

curl --location --request GET 'https://{vanity_domain}.implycloud.com/api/v1/clusters/<clusterId>/history/<resourceVersion> \
--header 'Authorization: Bearer <Bearer Token>'

Sample response

Toggle to show sample response

{
  "metadata" : {
    "name" : "My First Cluster"
    "uid" : "ffd5ea0f-5018-4649-97ee-1ddb0f8a2c53",
  },
  "spec" : {
    "version" : "version",
    "desiredState" : "STARTED",
    "awsInstanceRole" : "aws-instance-role",
    "awsKeyPair" : "aws-key-pair",
    "awsTags" : [ 
      {
        "name" : "tag-1",
        "value" : "tag-1-value"
      }, 
      {
        "name" : "tag-2",
        "value" : "tag-2-value"
      }
    ],
    "encryptVolumes" : true,
    "commonRuntimeProperties": [
      {
        "name": "common.druid.prop",
        "value": "value1"
      }
    ],
    "master": {
      "replicas": 3,
      "instanceType": "t2.small",
      "coordinatorRuntimeProperties": [
        {
          "name": "coordinator.druid.prop",
          "value": "value1"
        }
      ],
      "overlordRuntimeProperties": [
        {
          "name": "master.druid.property",
          "value": "value"
        }
      ]
    },
    "query": {
      "replicas": 2,
      "instanceType": "t2.small",
      "brokerRuntimeProperties": [
        {
          "name": "broker.druid.property",
          "value": "value"
        }
      ],
      "routerRuntimeProperties": [
        {
          "name": "router.druid.property",
          "value": "value"
        }
      ],
      "pivotConfiguration": "serverRoot: test\nuserMode: native"
    },
    "data": {
      "historicalRuntimeProperties": [
        {
          "name": "historical.druid.property",
          "value": "value"
        }
      ],
      "middleManagerRuntimeProperties": [
        {
          "name": "mm.druid.property",
          "value": "value"
        }
      ],
      "tier1": {
        "replicas": 2,
        "instanceType": "t2.small",
        "historicalRuntimeProperties": [
          {
            "name": "historical.druid.property",
            "value": "value"
          }
        ],
        "middleManagerRuntimeProperties": [
          {
            "name": "mm.druid.property",
            "value": "value"
          }
        ]
      },
      "tier2": {
        "replicas": 2,
        "instanceType": "t2.small",
        "historicalRuntimeProperties": [
          {
            "name": "historical.druid.property",
            "value": "value"
          }
        ],
        "middleManagerRuntimeProperties": [
          {
            "name": "mm.druid.property",
            "value": "value"
          }
        ]
      },
      "tier3": {
        "replicas": 2,
        "instanceType": "t2.small",
        "historicalRuntimeProperties": [
          {
            "name": "historical.druid.property",
            "value": "value"
          }
        ],
        "middleManagerRuntimeProperties": [
          {
            "name": "mm.druid.property",
            "value": "value"
          }
        ]
      }
    },
    "metadataStore": {
      "instanceType": "db.t2.small",
      "diskSize": 20,
      "backupRetention": 14,
      "monitoring": true,
      "encrypt": true
    },
    "pivot": {
      "accessMode": "PROXIED"
    },
    "deepStorage": {
      "path": "s3://my-bucket/my-prefix",
      "encrypt": true
    },
    "druidExtensions" : [ 
      "druid-extension-1",
      "druid-extension-2"
    ],
    "featureFlags" : [ 
      "featureFlag1",
      "featureFlag2"
    ],
    "customFiles" : [ 
      {
        "path" : "s3://my-bucket/my-file-1",
        "unpack" : false,
        "type" : "USER",
        "executable" : false
      },
      {
        "path" : "https://my-domain.com/my-file-2",
        "unpack" : false,
        "type" : "USER",
        "executable" : false
      }
    ],
  }
}