Create a compute pool
curl --request POST \
--url https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"display_name": "<string>",
"provider": {
"type": "snowflake_warehouse",
"warehouse_name": "<string>",
"auto_suspend": 123,
"auto_resume": true,
"min_cluster_count": 123,
"max_cluster_count": 123,
"max_concurrency_level": 123,
"statement_queued_timeout_in_seconds": 123,
"statement_timeout_in_seconds": 123,
"enable_query_acceleration": true,
"query_acceleration_max_scale_factor": 123,
"resource_constraint": "<string>",
"comment": "<string>"
},
"external_id": {
"type": "snowflake_warehouse",
"name": "<string>",
"alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"tags": [
"<string>"
],
"collaborators": {
"use": {
"type": "all"
}
}
}
'import requests
url = "https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools"
payload = {
"name": "<string>",
"display_name": "<string>",
"provider": {
"type": "snowflake_warehouse",
"warehouse_name": "<string>",
"auto_suspend": 123,
"auto_resume": True,
"min_cluster_count": 123,
"max_cluster_count": 123,
"max_concurrency_level": 123,
"statement_queued_timeout_in_seconds": 123,
"statement_timeout_in_seconds": 123,
"enable_query_acceleration": True,
"query_acceleration_max_scale_factor": 123,
"resource_constraint": "<string>",
"comment": "<string>"
},
"external_id": {
"type": "snowflake_warehouse",
"name": "<string>",
"alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"tags": ["<string>"],
"collaborators": { "use": { "type": "all" } }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
display_name: '<string>',
provider: {
type: 'snowflake_warehouse',
warehouse_name: '<string>',
auto_suspend: 123,
auto_resume: true,
min_cluster_count: 123,
max_cluster_count: 123,
max_concurrency_level: 123,
statement_queued_timeout_in_seconds: 123,
statement_timeout_in_seconds: 123,
enable_query_acceleration: true,
query_acceleration_max_scale_factor: 123,
resource_constraint: '<string>',
comment: '<string>'
},
external_id: {
type: 'snowflake_warehouse',
name: '<string>',
alias: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
},
description: '<string>',
tags: ['<string>'],
collaborators: {use: {type: 'all'}}
})
};
fetch('https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'display_name' => '<string>',
'provider' => [
'type' => 'snowflake_warehouse',
'warehouse_name' => '<string>',
'auto_suspend' => 123,
'auto_resume' => true,
'min_cluster_count' => 123,
'max_cluster_count' => 123,
'max_concurrency_level' => 123,
'statement_queued_timeout_in_seconds' => 123,
'statement_timeout_in_seconds' => 123,
'enable_query_acceleration' => true,
'query_acceleration_max_scale_factor' => 123,
'resource_constraint' => '<string>',
'comment' => '<string>'
],
'external_id' => [
'type' => 'snowflake_warehouse',
'name' => '<string>',
'alias' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'description' => '<string>',
'tags' => [
'<string>'
],
'collaborators' => [
'use' => [
'type' => 'all'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"provider\": {\n \"type\": \"snowflake_warehouse\",\n \"warehouse_name\": \"<string>\",\n \"auto_suspend\": 123,\n \"auto_resume\": true,\n \"min_cluster_count\": 123,\n \"max_cluster_count\": 123,\n \"max_concurrency_level\": 123,\n \"statement_queued_timeout_in_seconds\": 123,\n \"statement_timeout_in_seconds\": 123,\n \"enable_query_acceleration\": true,\n \"query_acceleration_max_scale_factor\": 123,\n \"resource_constraint\": \"<string>\",\n \"comment\": \"<string>\"\n },\n \"external_id\": {\n \"type\": \"snowflake_warehouse\",\n \"name\": \"<string>\",\n \"alias\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"collaborators\": {\n \"use\": {\n \"type\": \"all\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"provider\": {\n \"type\": \"snowflake_warehouse\",\n \"warehouse_name\": \"<string>\",\n \"auto_suspend\": 123,\n \"auto_resume\": true,\n \"min_cluster_count\": 123,\n \"max_cluster_count\": 123,\n \"max_concurrency_level\": 123,\n \"statement_queued_timeout_in_seconds\": 123,\n \"statement_timeout_in_seconds\": 123,\n \"enable_query_acceleration\": true,\n \"query_acceleration_max_scale_factor\": 123,\n \"resource_constraint\": \"<string>\",\n \"comment\": \"<string>\"\n },\n \"external_id\": {\n \"type\": \"snowflake_warehouse\",\n \"name\": \"<string>\",\n \"alias\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"collaborators\": {\n \"use\": {\n \"type\": \"all\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"provider\": {\n \"type\": \"snowflake_warehouse\",\n \"warehouse_name\": \"<string>\",\n \"auto_suspend\": 123,\n \"auto_resume\": true,\n \"min_cluster_count\": 123,\n \"max_cluster_count\": 123,\n \"max_concurrency_level\": 123,\n \"statement_queued_timeout_in_seconds\": 123,\n \"statement_timeout_in_seconds\": 123,\n \"enable_query_acceleration\": true,\n \"query_acceleration_max_scale_factor\": 123,\n \"resource_constraint\": \"<string>\",\n \"comment\": \"<string>\"\n },\n \"external_id\": {\n \"type\": \"snowflake_warehouse\",\n \"name\": \"<string>\",\n \"alias\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"collaborators\": {\n \"use\": {\n \"type\": \"all\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"type": "owned",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": 123,
"data_plane_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": {
"type": "snowflake_warehouse",
"name": "<string>",
"alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "<string>",
"display_name": "<string>",
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"provider": {
"type": "snowflake_warehouse",
"warehouse_name": "<string>",
"size": "x_small",
"warehouse_type": "standard",
"auto_suspend": 123,
"auto_resume": true,
"min_cluster_count": 123,
"max_cluster_count": 123,
"scaling_policy": "standard",
"max_concurrency_level": 123,
"statement_queued_timeout_in_seconds": 123,
"statement_timeout_in_seconds": 123,
"enable_query_acceleration": true,
"query_acceleration_max_scale_factor": 123,
"resource_constraint": "<string>",
"comment": "<string>"
},
"collaborators": {
"use": {
"type": "all"
}
},
"default_source": "company",
"description": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}Compute Pools
Create a compute pool
Create a new compute pool owned by the authenticated company.
POST
/
data-planes
/
{data_plane_id}
/
compute-pools
Create a compute pool
curl --request POST \
--url https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"display_name": "<string>",
"provider": {
"type": "snowflake_warehouse",
"warehouse_name": "<string>",
"auto_suspend": 123,
"auto_resume": true,
"min_cluster_count": 123,
"max_cluster_count": 123,
"max_concurrency_level": 123,
"statement_queued_timeout_in_seconds": 123,
"statement_timeout_in_seconds": 123,
"enable_query_acceleration": true,
"query_acceleration_max_scale_factor": 123,
"resource_constraint": "<string>",
"comment": "<string>"
},
"external_id": {
"type": "snowflake_warehouse",
"name": "<string>",
"alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"tags": [
"<string>"
],
"collaborators": {
"use": {
"type": "all"
}
}
}
'import requests
url = "https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools"
payload = {
"name": "<string>",
"display_name": "<string>",
"provider": {
"type": "snowflake_warehouse",
"warehouse_name": "<string>",
"auto_suspend": 123,
"auto_resume": True,
"min_cluster_count": 123,
"max_cluster_count": 123,
"max_concurrency_level": 123,
"statement_queued_timeout_in_seconds": 123,
"statement_timeout_in_seconds": 123,
"enable_query_acceleration": True,
"query_acceleration_max_scale_factor": 123,
"resource_constraint": "<string>",
"comment": "<string>"
},
"external_id": {
"type": "snowflake_warehouse",
"name": "<string>",
"alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"tags": ["<string>"],
"collaborators": { "use": { "type": "all" } }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
display_name: '<string>',
provider: {
type: 'snowflake_warehouse',
warehouse_name: '<string>',
auto_suspend: 123,
auto_resume: true,
min_cluster_count: 123,
max_cluster_count: 123,
max_concurrency_level: 123,
statement_queued_timeout_in_seconds: 123,
statement_timeout_in_seconds: 123,
enable_query_acceleration: true,
query_acceleration_max_scale_factor: 123,
resource_constraint: '<string>',
comment: '<string>'
},
external_id: {
type: 'snowflake_warehouse',
name: '<string>',
alias: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
},
description: '<string>',
tags: ['<string>'],
collaborators: {use: {type: 'all'}}
})
};
fetch('https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'display_name' => '<string>',
'provider' => [
'type' => 'snowflake_warehouse',
'warehouse_name' => '<string>',
'auto_suspend' => 123,
'auto_resume' => true,
'min_cluster_count' => 123,
'max_cluster_count' => 123,
'max_concurrency_level' => 123,
'statement_queued_timeout_in_seconds' => 123,
'statement_timeout_in_seconds' => 123,
'enable_query_acceleration' => true,
'query_acceleration_max_scale_factor' => 123,
'resource_constraint' => '<string>',
'comment' => '<string>'
],
'external_id' => [
'type' => 'snowflake_warehouse',
'name' => '<string>',
'alias' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'description' => '<string>',
'tags' => [
'<string>'
],
'collaborators' => [
'use' => [
'type' => 'all'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"provider\": {\n \"type\": \"snowflake_warehouse\",\n \"warehouse_name\": \"<string>\",\n \"auto_suspend\": 123,\n \"auto_resume\": true,\n \"min_cluster_count\": 123,\n \"max_cluster_count\": 123,\n \"max_concurrency_level\": 123,\n \"statement_queued_timeout_in_seconds\": 123,\n \"statement_timeout_in_seconds\": 123,\n \"enable_query_acceleration\": true,\n \"query_acceleration_max_scale_factor\": 123,\n \"resource_constraint\": \"<string>\",\n \"comment\": \"<string>\"\n },\n \"external_id\": {\n \"type\": \"snowflake_warehouse\",\n \"name\": \"<string>\",\n \"alias\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"collaborators\": {\n \"use\": {\n \"type\": \"all\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"provider\": {\n \"type\": \"snowflake_warehouse\",\n \"warehouse_name\": \"<string>\",\n \"auto_suspend\": 123,\n \"auto_resume\": true,\n \"min_cluster_count\": 123,\n \"max_cluster_count\": 123,\n \"max_concurrency_level\": 123,\n \"statement_queued_timeout_in_seconds\": 123,\n \"statement_timeout_in_seconds\": 123,\n \"enable_query_acceleration\": true,\n \"query_acceleration_max_scale_factor\": 123,\n \"resource_constraint\": \"<string>\",\n \"comment\": \"<string>\"\n },\n \"external_id\": {\n \"type\": \"snowflake_warehouse\",\n \"name\": \"<string>\",\n \"alias\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"collaborators\": {\n \"use\": {\n \"type\": \"all\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-dev.narrative.io/data-planes/{data_plane_id}/compute-pools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"display_name\": \"<string>\",\n \"provider\": {\n \"type\": \"snowflake_warehouse\",\n \"warehouse_name\": \"<string>\",\n \"auto_suspend\": 123,\n \"auto_resume\": true,\n \"min_cluster_count\": 123,\n \"max_cluster_count\": 123,\n \"max_concurrency_level\": 123,\n \"statement_queued_timeout_in_seconds\": 123,\n \"statement_timeout_in_seconds\": 123,\n \"enable_query_acceleration\": true,\n \"query_acceleration_max_scale_factor\": 123,\n \"resource_constraint\": \"<string>\",\n \"comment\": \"<string>\"\n },\n \"external_id\": {\n \"type\": \"snowflake_warehouse\",\n \"name\": \"<string>\",\n \"alias\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"collaborators\": {\n \"use\": {\n \"type\": \"all\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"type": "owned",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": 123,
"data_plane_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": {
"type": "snowflake_warehouse",
"name": "<string>",
"alias": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"name": "<string>",
"display_name": "<string>",
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"provider": {
"type": "snowflake_warehouse",
"warehouse_name": "<string>",
"size": "x_small",
"warehouse_type": "standard",
"auto_suspend": 123,
"auto_resume": true,
"min_cluster_count": 123,
"max_cluster_count": 123,
"scaling_policy": "standard",
"max_concurrency_level": 123,
"statement_queued_timeout_in_seconds": 123,
"statement_timeout_in_seconds": 123,
"enable_query_acceleration": true,
"query_acceleration_max_scale_factor": 123,
"resource_constraint": "<string>",
"comment": "<string>"
},
"collaborators": {
"use": {
"type": "all"
}
},
"default_source": "company",
"description": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The data plane this compute pool belongs to.
Body
application/json
A unique slug identifier for the compute pool within a (company, data plane) scope.
A human-readable name for the compute pool.
- Option 1
- Option 2
Show child attributes
Show child attributes
Required for the snowflake_warehouse provider (carries the warehouse name and alias). Optional for the aws_emr provider — the only meaningful field there is the type discriminator, which the server fills in automatically when the field is omitted. Sent as null when omitted.
- Option 1
- Option 2
Show child attributes
Show child attributes
An optional description of the compute pool.
Show child attributes
Show child attributes
Response
Created
- Option 1
- Option 2
Available options:
owned - Option 1
- Option 2
Show child attributes
Show child attributes
Available options:
active, archived - Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Set when this pool is the compute pool the authenticated company's jobs run on when they don't name one themselves, and says which level made it the default. null on every other pool. Exactly one active pool per data plane can carry a non-null value.
Available options:
company, data_plane Null until the pool has been updated at least once.
Was this page helpful?