Options

Get cluster options

GET
Get all possible options for configuring a cluster.

Path parameters

organizationIdstringRequired
The ID of the Organization to get cluster options for.

Query parameters

providerenumOptional
The cluster's cloud provider.
Allowed values: AWSAZUREGCP
typeenumRequired
The cluster type.
Allowed values: DEDICATEDHYBRID

Response

This endpoint returns a list of objects
databaseInstances
list of objects
The available database instances.
defaultDatabaseInstance
object
defaultNodeInstance
object
defaultRegion
object
defaultVpcSubnetRange
string
The default VPC subnet range.
nodeCountDefault
integer
The default number of nodes.
nodeCountMax
integer
The maximum number of nodes.
nodeCountMin
integer
The minimum number of nodes.
nodeInstances
list of objects
The available node instances.
provider
enum
The cloud provider.
Allowed values: AWSAZUREGCP
regions
list of objects
The available regions.
defaultPodSubnetRange
stringOptional
The default pod subnet range.
defaultServicePeeringRange
stringOptional
The default service peering range.
defaultServiceSubnetRange
stringOptional
The default service subnet range.
GET
1curl -G https://api.astronomer.io/platform/v1beta1/organizations/organizationId/cluster-options \
2 -H "Authorization: Bearer <token>" \
3 -d type=DEDICATED
Response
1[
2 {
3 "databaseInstances": [
4 {
5 "cpu": 4,
6 "memory": "16Gi",
7 "name": "e2-standard-4"
8 }
9 ],
10 "defaultDatabaseInstance": {
11 "cpu": 4,
12 "memory": "16Gi",
13 "name": "e2-standard-4"
14 },
15 "defaultNodeInstance": {
16 "cpu": 4,
17 "memory": "16Gi",
18 "name": "e2-standard-4"
19 },
20 "defaultRegion": {
21 "name": "us-east-1",
22 "bannedInstances": [
23 "bannedInstances"
24 ],
25 "limited": true
26 },
27 "defaultVpcSubnetRange": "172.20.0.0/19",
28 "nodeCountDefault": 20,
29 "nodeCountMax": 100,
30 "nodeCountMin": 2,
31 "nodeInstances": [
32 {
33 "cpu": 4,
34 "memory": "16Gi",
35 "name": "e2-standard-4"
36 }
37 ],
38 "provider": "AWS",
39 "regions": [
40 {
41 "name": "us-east-1",
42 "limited": true
43 }
44 ],
45 "defaultPodSubnetRange": "172.21.0.0/19",
46 "defaultServicePeeringRange": "172.23.0.0/20",
47 "defaultServiceSubnetRange": "172.22.0.0/22"
48 }
49]