DataPlatformNodePool | Sections Test

List the DataPlatformNodePools of a DataPlatformCluster

get

List all node pools assigned to the specified DataPlatformCluster by its ID.

The cluster ID can be found in the response when a cluster is created or when you GET a list of all DataPlatformClusters.

Authorizations

Path parameters

clusterIdstring · uuid · min: 32 · max: 36Required

The unique ID of the cluster. Must conform to the UUID format.

Pattern: ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$

Responses

200

List of all node pools assigned to a specific DataPlatformCluster.

application/json

400

### Bad Request The request send to the API was malformed.

application/json

401

### Unauthorized The request is missing authorization information or the authorization information provided are expired.

application/json

403

### Not Allowed The user issuing the request does not have the needed permissions.

application/json

404

### Not Found The resource that was requested could not be found.

application/json

500

### Internal Server Error An internal error occurred. We apologize for the inconvenience!

application/json

get

GET /dataplatform/clusters/{clusterId}/nodepools HTTP/1.1
Host: api.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "dataplatform/clusters",
  "type": "collection",
  "href": "https://.../clusters/.../nodepools",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "nodepool",
      "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e/nodepools/abcd7e2f-9876-1234-abcd-123459498ae7",
      "metadata": {
        "ETag": "123aaa5d587dcd0d58f767d464abcdef",
        "createdDate": "2020-12-10T13:37:50Z",
        "createdBy": "[email protected]",
        "createdByUserId": "12345693-9ae1-40c5-9b49-7c0afeabcdef",
        "createdInContractNumber": "12315812",
        "lastModifiedDate": "2020-12-11T13:37:50Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "98765493-9ae1-40c5-9b49-7c0afefedcba",
        "currentDataPlatformVersion": "22.11",
        "currentDataPlatformRevision": 2,
        "availableUpgradeVersions": [
          "22.11"
        ],
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "my-node-pool",
        "dataPlatformVersion": "22.11",
        "datacenterId": "123e4567-e89b-12d3-a456-426614174000",
        "nodeCount": 2,
        "cpuFamily": "AUTO",
        "coresCount": 4,
        "ramSize": 4096,
        "availabilityZone": "AUTO",
        "storageType": "SSD",
        "storageSize": 20,
        "maintenanceWindow": {
          "time": "16:30:59",
          "dayOfTheWeek": "Monday"
        },
        "labels": {
          "foo": "bar"
        },
        "annotations": {
          "foo": "bar"
        },
        "autoScaling": {
          "minNodeCount": 1,
          "maxNodeCount": 10
        }
      }
    }
  ]
}

Create a DataPlatformNodePool for a distinct DataPlatformCluster

post

Creates a new node pool and assigns the node pool resources exclusively to the defined managed cluster.

The cluster ID can be found in the response when a cluster is created or when you GET a list of all DataPlatformClusters.

Authorizations

Path parameters

clusterIdstring · uuid · min: 32 · max: 36Required

The unique ID of the cluster. Must conform to the UUID format.

Pattern: ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$

Body

Data to create a new node pool for a DataPlatformNodePool.

Responses

200

The DataPlatformCluster node pool as stored after the create or update operation was applied or the DataPlatformCluster node pool properties before the delete operation was performed.

application/json

400

### Bad Request The request send to the API was malformed.

application/json

401

### Unauthorized The request is missing authorization information or the authorization information provided are expired.

application/json

403

### Not Allowed The user issuing the request does not have the needed permissions.

application/json

404

### Not Found The resource that was requested could not be found.

application/json

500

### Internal Server Error An internal error occurred. We apologize for the inconvenience!

application/json

post

POST /dataplatform/clusters/{clusterId}/nodepools HTTP/1.1
Host: api.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 330

{
  "properties": {
    "name": "my-node-pool",
    "nodeCount": 2,
    "cpuFamily": "AUTO",
    "coresCount": 4,
    "ramSize": 4096,
    "availabilityZone": "AUTO",
    "storageType": "SSD",
    "storageSize": 20,
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "labels": {
      "foo": "bar"
    },
    "annotations": {
      "foo": "bar"
    },
    "autoScaling": {
      "minNodeCount": 1,
      "maxNodeCount": 10
    }
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "nodepool",
  "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e/nodepools/abcd7e2f-9876-1234-abcd-123459498ae7",
  "metadata": {
    "ETag": "123aaa5d587dcd0d58f767d464abcdef",
    "createdDate": "2020-12-10T13:37:50Z",
    "createdBy": "[email protected]",
    "createdByUserId": "12345693-9ae1-40c5-9b49-7c0afeabcdef",
    "createdInContractNumber": "12315812",
    "lastModifiedDate": "2020-12-11T13:37:50Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "98765493-9ae1-40c5-9b49-7c0afefedcba",
    "currentDataPlatformVersion": "22.11",
    "currentDataPlatformRevision": 2,
    "availableUpgradeVersions": [
      "22.11"
    ],
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "my-node-pool",
    "dataPlatformVersion": "22.11",
    "datacenterId": "123e4567-e89b-12d3-a456-426614174000",
    "nodeCount": 2,
    "cpuFamily": "AUTO",
    "coresCount": 4,
    "ramSize": 4096,
    "availabilityZone": "AUTO",
    "storageType": "SSD",
    "storageSize": 20,
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "labels": {
      "foo": "bar"
    },
    "annotations": {
      "foo": "bar"
    },
    "autoScaling": {
      "minNodeCount": 1,
      "maxNodeCount": 10
    }
  }
}

Retrieve a DataPlatformNodePool

get

Retrieve a node pool belonging to a Kubernetes cluster running Stackable by using its ID.

The cluster ID can be found in the response when a cluster is created or when you GET a list of all DataPlatformClusters.

The node pool ID can be found in the response when a node pool is created or when you GET a list of all node pools assigned to a specific DataPlatformCluster.

Authorizations

Path parameters

clusterIdstring · uuid · min: 32 · max: 36Required

The unique ID of the cluster. Must conform to the UUID format.

Pattern: ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$

nodepoolIdstring · uuid · min: 32 · max: 36Required

The unique ID of the node pool. Must conform to the UUID format.

Pattern: ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$

Responses

200

The DataPlatformCluster node pool as stored after the create or update operation was applied or the DataPlatformCluster node pool properties before the delete operation was performed.

application/json

400

### Bad Request The request send to the API was malformed.

application/json

401

### Unauthorized The request is missing authorization information or the authorization information provided are expired.

application/json

403

### Not Allowed The user issuing the request does not have the needed permissions.

application/json

404

### Not Found The resource that was requested could not be found.

application/json

500

### Internal Server Error An internal error occurred. We apologize for the inconvenience!

application/json

get

GET /dataplatform/clusters/{clusterId}/nodepools/{nodepoolId} HTTP/1.1
Host: api.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "nodepool",
  "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e/nodepools/abcd7e2f-9876-1234-abcd-123459498ae7",
  "metadata": {
    "ETag": "123aaa5d587dcd0d58f767d464abcdef",
    "createdDate": "2020-12-10T13:37:50Z",
    "createdBy": "[email protected]",
    "createdByUserId": "12345693-9ae1-40c5-9b49-7c0afeabcdef",
    "createdInContractNumber": "12315812",
    "lastModifiedDate": "2020-12-11T13:37:50Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "98765493-9ae1-40c5-9b49-7c0afefedcba",
    "currentDataPlatformVersion": "22.11",
    "currentDataPlatformRevision": 2,
    "availableUpgradeVersions": [
      "22.11"
    ],
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "my-node-pool",
    "dataPlatformVersion": "22.11",
    "datacenterId": "123e4567-e89b-12d3-a456-426614174000",
    "nodeCount": 2,
    "cpuFamily": "AUTO",
    "coresCount": 4,
    "ramSize": 4096,
    "availabilityZone": "AUTO",
    "storageType": "SSD",
    "storageSize": 20,
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "labels": {
      "foo": "bar"
    },
    "annotations": {
      "foo": "bar"
    },
    "autoScaling": {
      "minNodeCount": 1,
      "maxNodeCount": 10
    }
  }
}

Remove a DataPlatformNodePool from a DataPlatformCluster

delete

Removes the specified node pool from the specified DataPlatformCluster and deletes the node pool afterwards.

The cluster ID can be found in the response when a cluster is created or when you GET a list of all DataPlatformClusters.

The node pool ID can be found in the response when a node pool is created or when you GET a list of all node pools assigned to a specific DataPlatformCluster.

Authorizations

Path parameters

clusterIdstring · uuid · min: 32 · max: 36Required

The unique ID of the cluster. Must conform to the UUID format.

Pattern: ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$

nodepoolIdstring · uuid · min: 32 · max: 36Required

The unique ID of the node pool. Must conform to the UUID format.

Pattern: ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$

Responses

200

The DataPlatformCluster node pool as stored after the create or update operation was applied or the DataPlatformCluster node pool properties before the delete operation was performed.

application/json

400

### Bad Request The request send to the API was malformed.

application/json

401

### Unauthorized The request is missing authorization information or the authorization information provided are expired.

application/json

403

### Not Allowed The user issuing the request does not have the needed permissions.

application/json

404

### Not Found The resource that was requested could not be found.

application/json

500

### Internal Server Error An internal error occurred. We apologize for the inconvenience!

application/json

delete

DELETE /dataplatform/clusters/{clusterId}/nodepools/{nodepoolId} HTTP/1.1
Host: api.ionos.com
Authorization: Bearer JWT
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "nodepool",
  "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e/nodepools/abcd7e2f-9876-1234-abcd-123459498ae7",
  "metadata": {
    "ETag": "123aaa5d587dcd0d58f767d464abcdef",
    "createdDate": "2020-12-10T13:37:50Z",
    "createdBy": "[email protected]",
    "createdByUserId": "12345693-9ae1-40c5-9b49-7c0afeabcdef",
    "createdInContractNumber": "12315812",
    "lastModifiedDate": "2020-12-11T13:37:50Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "98765493-9ae1-40c5-9b49-7c0afefedcba",
    "currentDataPlatformVersion": "22.11",
    "currentDataPlatformRevision": 2,
    "availableUpgradeVersions": [
      "22.11"
    ],
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "my-node-pool",
    "dataPlatformVersion": "22.11",
    "datacenterId": "123e4567-e89b-12d3-a456-426614174000",
    "nodeCount": 2,
    "cpuFamily": "AUTO",
    "coresCount": 4,
    "ramSize": 4096,
    "availabilityZone": "AUTO",
    "storageType": "SSD",
    "storageSize": 20,
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "labels": {
      "foo": "bar"
    },
    "annotations": {
      "foo": "bar"
    },
    "autoScaling": {
      "minNodeCount": 1,
      "maxNodeCount": 10
    }
  }
}

Partially Modify a DataPlatformNodePool

patch

Modifies the specified node pool of a DataPlatformCluster. Update selected attributes of a node pool belonging to a Kubernetes cluster running Stackable.

The fields in the request body are applied to the cluster. Note that the application to the node pool itself is performed asynchronously. You can check the sync state by querying the node pool with the GET method.

The cluster ID can be found in the response when a cluster is created or when you GET a list of all DataPlatformClusters.

The node pool ID can be found in the response when a node pool is created or when you GET a list of all node pools assigned to a specific DataPlatformCluster.

Authorizations

Path parameters

clusterIdstring · uuid · min: 32 · max: 36Required

The unique ID of the cluster. Must conform to the UUID format.

Pattern: ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$

nodepoolIdstring · uuid · min: 32 · max: 36Required

The unique ID of the node pool. Must conform to the UUID format.

Pattern: ^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$

Body

Data to update selected properties of a node pool for a DataPlatformNodePool.

Responses

200

The DataPlatformCluster node pool as stored after the create or update operation was applied or the DataPlatformCluster node pool properties before the delete operation was performed.

application/json

400

### Bad Request The request send to the API was malformed.

application/json

401

### Unauthorized The request is missing authorization information or the authorization information provided are expired.

application/json

403

### Not Allowed The user issuing the request does not have the needed permissions.

application/json

404

### Not Found The resource that was requested could not be found.

application/json

500

### Internal Server Error An internal error occurred. We apologize for the inconvenience!

application/json

patch

PATCH /dataplatform/clusters/{clusterId}/nodepools/{nodepoolId} HTTP/1.1
Host: api.ionos.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "properties": {
    "nodeCount": 2,
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "labels": {
      "foo": "bar"
    },
    "annotations": {
      "foo": "bar"
    },
    "autoScaling": {}
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "nodepool",
  "href": "https://api.ionos.com/dataplatform/clusters/498ae72f-411f-11eb-9d07-046c59cc737e/nodepools/abcd7e2f-9876-1234-abcd-123459498ae7",
  "metadata": {
    "ETag": "123aaa5d587dcd0d58f767d464abcdef",
    "createdDate": "2020-12-10T13:37:50Z",
    "createdBy": "[email protected]",
    "createdByUserId": "12345693-9ae1-40c5-9b49-7c0afeabcdef",
    "createdInContractNumber": "12315812",
    "lastModifiedDate": "2020-12-11T13:37:50Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "98765493-9ae1-40c5-9b49-7c0afefedcba",
    "currentDataPlatformVersion": "22.11",
    "currentDataPlatformRevision": 2,
    "availableUpgradeVersions": [
      "22.11"
    ],
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "my-node-pool",
    "dataPlatformVersion": "22.11",
    "datacenterId": "123e4567-e89b-12d3-a456-426614174000",
    "nodeCount": 2,
    "cpuFamily": "AUTO",
    "coresCount": 4,
    "ramSize": 4096,
    "availabilityZone": "AUTO",
    "storageType": "SSD",
    "storageSize": 20,
    "maintenanceWindow": {
      "time": "16:30:59",
      "dayOfTheWeek": "Monday"
    },
    "labels": {
      "foo": "bar"
    },
    "annotations": {
      "foo": "bar"
    },
    "autoScaling": {
      "minNodeCount": 1,
      "maxNodeCount": 10
    }
  }
}