Cluster

List clusters

GET
List clusters in an Organization.

Path parameters

organizationIdstringRequired
The Organization's unique ID.

Query parameters

namesstringOptional
A list of names for Clusters to filter by. The API returns details only for the specified Clusters.
providerenumOptional
The cloud provider to list clusters for. Clusters from other providers will be filtered out of the results.
Allowed values: AWSAZUREGCP
offsetintegerOptional
The number of results to skip before returning values.
limitintegerOptional
The maximum number of results to return.
sortsenumOptional

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Response

This endpoint returns an object
clusters
list of objects
The list of clusters in the current page.
limit
integer
The maximum number of clusters in one page.
offset
integer
The offset of the current page of clusters.
totalCount
integer
The total number of clusters.
GET
1curl https://api.astronomer.io/platform/v1beta1/organizations/organizationId/clusters \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "clusters": [
3    {
4      "cloudProvider": "AWS",
5      "createdAt": "2022-11-22T04:37:12Z",
6      "dbInstanceType": "db.t3.medium",
7      "id": "clm7k8tgw000008jz97i37y81",
8      "name": "my cluster",
9      "organizationId": "clm88r8hi000008jwhzxu5crg",
10      "region": "us-east-1",
11      "status": "CREATING",
12      "type": "DEDICATED",
13      "updatedAt": "2022-11-22T04:37:12Z",
14      "vpcSubnetRange": "172.20.0.0/22",
15      "isLimited": false,
16      "metadata": {
17        "oidcIssuerUrl": "https://westus2.oic.prod-aks.azure.com/b84efac8-cfae-467a-b223-23b9aea1486d/3075f79e-abc2-4602-a691-28117197e83d/"
18      },
19      "nodePools": [
20        {
21          "cloudProvider": "AWS",
22          "clusterId": "clm891jb6000308jrc3vjdtde",
23          "createdAt": "2022-11-22T04:37:12Z",
24          "id": "clm890zhe000208jr39dd0ubs",
25          "isDefault": true,
26          "maxNodeCount": 1,
27          "name": "default",
28          "nodeInstanceType": "t3.medium",
29          "updatedAt": "2022-11-22T04:37:12Z"
30        }
31      ],
32      "podSubnetRange": "172.21.0.0/19",
33      "providerAccount": "provider-account",
34      "servicePeeringRange": "172.23.0.0/20",
35      "serviceSubnetRange": "172.22.0.0/22",
36      "tags": [
37        {
38          "key": "key1",
39          "value": "value1"
40        }
41      ],
42      "tenantId": "your-tenant-id",
43      "workspaceIds": [
44        "workspaceIds"
45      ]
46    }
47  ],
48  "limit": 10,
49  "offset": 0,
50  "totalCount": 100
51}
Built with