Skip to main content

Clouds

A cloud represents a compute environment (AWS) in which Dremio Cloud engines run. A cloud can be associated with many projects. This API allows you to add, modify, delete, and list clouds.

Cloud Object
  {
    "name": "aws-cloud",
    "id": "88535550-b138-441f-a705-a46ac1808508",
    "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "createdAt": "Thu Aug 19 14:39:52 UTC 2021",
    "modifiedAt": "Thu Aug 19 14:40:17 UTC 2021",
    "attributes": {
      "vendor": "aws",
      "region": "US_WEST_2",
      "subnets": [
        "subnet-f4dec3df",
        "subnet-e9a0fedd"
      ],
      "securityGroups": [
        "sg-03b443cd073634008"
      ],
      "credentials": {
        "type": "ACCESS_KEY",
        "accessKeyId": "AKIAJIPU77TQL8LR6OIR",    
        "secretAccessKey": null
      },
      "vpcEndpointId": "vpce-020b6e4fc2c494f27"
    }
  }

Attributes​

{{< api-section file="data/api/clouds.json" data="cloud-attributes" >}}

attributes​

{{< api-section file="data/api/clouds.json" data="cloudAttributes" >}}

credentials​

{{< api-section file="data/api/clouds.json" data="credentials" >}}

Listing All Clouds​

Returns a list of all the clouds and the metadata for each cloud.

Listing All Clouds
GET /v0/clouds
Example Request
curl -X GET 'https://api.dremio.cloud/v0/clouds' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
[
  {
    "name": "Default",
    "id": "436d7b40-d665-469a-a7fc-9110d0226488",
    "createdBy": "72974047-213c-497d-8ead-281f5ea25812",
    "modifiedBy": "f6f25d77-8322-4fa0-96c7-575c9e65c210",
    "createdAt": "Thu Jul 01 18:02:38 UTC 2021",
    "modifiedAt": "Tue Dec 21 03:38:43 UTC 2021",
    "attributes": {
      "vendor": "aws",
      "region": "US_WEST_2",
      "subnets": [
        "subnet-f4dec3df",
        "subnet-e9a0fedd"        
      ],
      "securityGroups": [
        "sg-0e0f5c5e4b105262d"
      ],
      "credentials": {
        "type": "IAM_ROLE",
        "roleArn": "arn:aws:iam::388677480418:role/user-test3-DremioIAMCloudComputeRole-ULX75AWAKA0O",
        "externalId": null
      },
      "vpcEndpointId": null
    },
    "projectRefs": []
  },
  {
    "name": "docCloud",
    "id": "52217be6-9f05-487a-ab2d-c8e38081d683",
    "createdBy": "f6f25d77-8322-4fa0-96c7-574c9f65c210",
    "modifiedBy": "f6f25d77-8322-4fa0-96c7-574c9f65c210",
    "createdAt": "Fri Dec 17 20:36:16 UTC 2021",
    "modifiedAt": "Fri Dec 17 20:36:16 UTC 2021",
    "attributes": {
      "vendor": "aws",
      "region": "US_WEST_2",
      "subnets": [
        "subnet-81e255f9"
      ],
      "securityGroups": [
        "sg-03b443cd073634008"
      ],
      "credentials": {
        "type": "ACCESS_KEY",
        "accessKeyId": "AKIAJIQU77TQL8LR6OIR",
        "secretAccessKey": null
      },
      "vpcEndpointId": null
    },
    "projectRefs": []
  }
]

Responses​

{{< api-responses file="data/api/clouds.json" data="addingAllCloudsResponses" >}}

Adding a Cloud​

Add a cloud.

Adding a Cloud
POST /v0/clouds

Parameters​

Cloud​

{{< api-section file="data/api/clouds.json" data="addingCloudParameters" >}}

attributes​

{{< api-section file="data/api/clouds.json" data="addingCloudAttributesParameters" >}}

credentials​

{{< api-section file="data/api/clouds.json" data="addingCloudCredentialsParameters" >}}


Example Request
curl -X POST 'https://api.dremio.cloud/v0/clouds' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json' \
-d '{
  "name": "docCloud",
  "attributes": {
    "vendor": "AWS",
    "region": "US_WEST_2",
    "subnets": [
      "subnet-81e255f9"
    ],
    "securityGroups": [
      "sg-03b443cd073634008"
    ],
    "credentials": {
      "type": "ACCESS_KEY",
      "accessKeyId": "AKIAJIPU77TQL8LR6OIR",
      "secretAccessKey": "vJalrXUtnFEMI/K7MDENG/bPxRfiDYEXAMPLEKEY"
    },
    "vpcEndpointId": "vpce-020b6e4fc2c494f27"
  },
  "requestId": "302272c0-d357-4bcc-9087-19f3056a9a73"
}'
Example Response
{
  "id": "e43e8505-8a44-4dc5-8181-75be1067cf99"
}

Responses​

{{< api-responses file="data/api/clouds.json" data="addingCloudResponses" >}}

Retrieving a Cloud​

Get the cloud metadata for an existing cloud by providing the cloud ID that was returned on creation of the cloud.

Retrieving a Cloud
GET /v0/clouds/{id}

Parameters​

{{< api-section file="data/api/clouds.json" data="retrievingCloudParameters" >}}

Example Request
curl -X GET 'https://api.dremio.cloud/v0/clouds/e43e8505-8a44-4dc5-8181-75be1067cf99' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
  {
  "name": "docCloud",
  "id": "e43e8505-8a44-4dc5-8181-75be1067cf99",
  "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
  "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
  "createdAt": "Sat Aug 21 16:37:18 UTC 2021",
  "modifiedAt": "Sat Aug 21 16:37:18 UTC 2021",
  "attributes": {
    "vendor": "aws",
    "region": "US_WEST_2",
    "subnets": [
      "subnet-f4dec3df",
      "subnet-e9a0fedd"
    ],
    "securityGroups": [
      "sg-03b443cd073634008"
    ],
    "credentials": {
      "type": "ACCESS_KEY",
      "accessKeyId": "AKIAJIPU77TQL8LR6OIR",
      "secretAccessKey": null
    },
    "vpcEndpointId": "vpce-020b6e4fc2c494f27"
  }
}

Responses​

{{< api-responses file="data/api/clouds.json" data="retrievingCloudResponses" >}}

Modifying a Cloud​

Modify the cloud by providing the cloud ID that was returned on creation of the cloud. Parameters that are not provided will be left unchanged.

Modifying a Cloud
PUT /v0/clouds/{id}

Parameters​

Cloud​

{{< api-section file="data/api/clouds.json" data="modifyingCloudParameters" >}}

attributes​

{{< api-section file="data/api/clouds.json" data="modifyingCloudAttributesParameters" >}}

credentials​

{{< api-section file="data/api/clouds.json" data="modifyingCloudCredentialsParameters" >}}


Example Request
curl -X PUT 'https://api.dremio.cloud/v0/clouds/290f1ee-6c54-4b01-90e6-d701748f0851' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json' \
-d '{
  "name": "myCloud",
  "attributes": {
    "vendor": "aws",
    "region": "US_WEST_2",
    "subnets": [
      "subnet-81e255f9"
    ],
    "securityGroups": [
      "sg-00507c41e91010ebf"
    ],
    "credentials": {
      "type": "ACCESS_KEY",
      "accessKeyId": "AKIAJIPU77TQL8LR6OIR",
      "secretAccessKey": "vJalrXUtnFEMI/K7MDENG/bPxRfiDYEXAMPLEKEY"
    },
    "vpcEndpointId": "vpce-020b6e4fc2c494f27"
  }
}'
Example Response
No response

Responses​

{{< api-responses file="data/api/clouds.json" data="modifyingCloudResponses" >}}

Deleting a Cloud​

Delete the cloud by providing the cloud ID that was returned on creation of the cloud.

Deleting a Cloud
DELETE /v0/clouds/{id}

Parameters​

{{< api-section file="data/api/clouds.json" data="deletingCloudParameters" >}}

Example Request
curl -X DELETE 'https://api.dremio.cloud/v0/clouds/290f1ee-6c54-4b01-90e6-d701748f0851' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
No response

Responses​

{{< api-responses file="data/api/clouds.json" data="deletingCloudResponses" >}}