Skip to main content

Engine Preview

Dremio Arctic enables you to run optimization jobs to help you manage the accumulation of the data files that occurs through DML operations. This API allows you to add, update, and retrieve engines that run the optimization jobs.

Engine Object
{
  "credentials": {
    "type": "ACCESS_KEY",
    "accessKeyId": "8BDLDGT42KJ4JEXAMPLE"
  },
  "cloudId": "bc5787c6-e9bf-4159-a1b0-93d3cc6f19e9",
  "logStorageLocation": "usrsdre-test-west1/usrsdre/",
  "engineSize": "XX_SMALL_V1",
  "state": "ENABLED",
  "errorMessage": null
}

Engine Attributes​

{{< api-section file="data/api/arctic-engine.json" data="engine-attributes" >}}

credentials Object Attributes​

{{< api-section file="data/api/arctic-engine.json" data="credentials-object" >}}

Adding or Updating an Engine​

Adds or modifies an engine for the specified Arctic catalog that will run optimization jobs.

Method and URL
POST /v0/arctic/catalogs/{catalogId}/engine

Parameters​

{{< api-section file="data/api/arctic-engine.json" data="addingEngine" >}}

credentials Object Parameters​

{{< api-section file="data/api/arctic-engine.json" data="credentials-object-parameters" >}}


Example Request
curl -X POST 'https://api.dremio.cloud/v0/arctic/catalogs/1a234bc5-6789-46d7-b9cb-d236e195b34a/engine \
--header 'Authorization: Bearer <personal access token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "cloudId": "bc5787c6-e9bf-4159-a1b0-93d3cc6f19e9",
  "credentials": {
    "type": "ACCESS_KEY",
    "accessKeyId": "8BDLDGT42KJ4JEXAMPLE",
    "secretAccessKey": "94yLpEH2fhX3CrfrgE93742d8YyDr89tNEXAMPLE"
  },
  "engineSize": "XX_SMALL_V1",
  "logStorageLocation": "usrsdre-test-west1/usrsdre/"
}'
Example Response
{
  "cloudId": "bc5787c6-e9bf-4159-a1b0-93d3cc6f19e9",
  "credentials": {
    "accessKeyId": "8BDLDGT42KJ4JEXAMPLE",
    "type": "ACCESS_KEY"
  },
  "engineSize": "XX_SMALL_V1",
  "logStorageLocation": "usrsdre-test-west1/usrsdre/",
  "state": "CREATING"
}

Responses​

{{< api-responses file="data/api/arctic-engine.json" data="addingEngine-Responses" >}}

Retrieving an Engine​

Retrieve the engine the Arctic catalog uses.

Method and URL
GET /v0/arctic/catalogs/{catalogId}/engine

Parameters​

{{< api-section file="data/api/arctic-engine.json" data="retrievingEngine" >}}

Example Request
curl -X GET 'https://api.dremio.cloud/v0/catalogs/1a234bc5-6789-46d7-b9cb-d236e195b34a/engine' \
--header 'Authorization: Bearer <personal access token>' \
--header 'Content-Type: application/json'
Example Response
{
  "credentials": {
    "type": "ACCESS_KEY",
    "accessKeyId": "8BDLDGT42KJ4J5SNSL2Z"
  },
  "cloudId": "bc5787c6-e9bf-4159-a1b0-93d3cc6f19e9",
  "logStorageLocation": "usrsdre-test-west1/usrsdre/",
  "engineSize": "XX_SMALL_V1",
  "state": "ENABLED",
  "errorMessage": null
}

Responses​

{{< api-responses file="data/api/arctic-engine.json" data="retrievingEngine-Responses" >}}