Get cluster options

1 curl -G https://api.astronomer.io/platform/v1beta1/organizations/organizationId/cluster-options \ 2 -H "Authorization: Bearer <token>" \ 3 -d type=DEDICATED

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 "defaultPodSubnetRange": "172.21.0.0/19", 21 "defaultRegion": { 22 "bannedInstances": [ 23 "t3.medium" 24 ], 25 "limited": true, 26 "name": "us-east-1" 27 }, 28 "defaultServicePeeringRange": "172.23.0.0/20", 29 "defaultServiceSubnetRange": "172.22.0.0/22", 30 "defaultVpcSubnetRange": "172.20.0.0/19", 31 "nodeCountDefault": 20, 32 "nodeCountMax": 100, 33 "nodeCountMin": 2, 34 "nodeInstances": [ 35 { 36 "cpu": 4, 37 "memory": "16Gi", 38 "name": "e2-standard-4" 39 } 40 ], 41 "provider": "AZURE", 42 "regions": [ 43 { 44 "bannedInstances": [ 45 "t3.medium" 46 ], 47 "limited": true, 48 "name": "us-east-1" 49 } 50 ] 51 } 52 ]

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:

typeenumRequired

The cluster type.

Allowed values:

Response

databaseInstanceslist of objects

The available database instances.

defaultDatabaseInstanceobject

defaultNodeInstanceobject

defaultRegionobject

defaultVpcSubnetRangestring

The default VPC subnet range.

nodeCountDefaultinteger

The default number of nodes.

nodeCountMaxinteger

The maximum number of nodes.

nodeCountMininteger

The minimum number of nodes.

nodeInstanceslist of objects

The available node instances.

providerenum

The cloud provider.

Allowed values:

regionslist of objects

The available regions.

defaultPodSubnetRangestringOptional

The default pod subnet range.

defaultServicePeeringRangestringOptional

The default service peering range.

defaultServiceSubnetRangestringOptional

The default service subnet range.

Path parameters

Headers

Query parameters

Response

Errors