ionoscloud 5.0.0 → 5.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/AttachedVolumes.md +30 -0
- data/docs/BackupUnit.md +26 -0
- data/docs/BackupUnitApi.md +595 -0
- data/docs/BackupUnitProperties.md +22 -0
- data/docs/BackupUnitSSO.md +18 -0
- data/docs/BackupUnits.md +24 -0
- data/docs/BalancedNics.md +30 -0
- data/docs/CHANGELOG.md +1 -0
- data/docs/Cdroms.md +30 -0
- data/docs/ConnectableDatacenter.md +22 -0
- data/docs/Contract.md +20 -0
- data/docs/ContractApi.md +89 -0
- data/docs/ContractProperties.md +26 -0
- data/docs/DataCenterApi.md +517 -0
- data/docs/DataCenterEntities.md +24 -0
- data/docs/Datacenter.md +28 -0
- data/docs/DatacenterElementMetadata.md +32 -0
- data/docs/DatacenterProperties.md +28 -0
- data/docs/Datacenters.md +30 -0
- data/docs/DefaultApi.md +84 -0
- data/docs/Error.md +20 -0
- data/docs/ErrorMessage.md +20 -0
- data/docs/FirewallRule.md +26 -0
- data/docs/FirewallRules.md +30 -0
- data/docs/FirewallruleProperties.md +34 -0
- data/docs/Group.md +26 -0
- data/docs/GroupEntities.md +20 -0
- data/docs/GroupMembers.md +24 -0
- data/docs/GroupProperties.md +36 -0
- data/docs/GroupShare.md +24 -0
- data/docs/GroupShareProperties.md +20 -0
- data/docs/GroupShares.md +24 -0
- data/docs/GroupUsers.md +24 -0
- data/docs/Groups.md +24 -0
- data/docs/IPBlocksApi.md +513 -0
- data/docs/IPFailover.md +20 -0
- data/docs/Image.md +26 -0
- data/docs/ImageApi.md +429 -0
- data/docs/ImageProperties.md +50 -0
- data/docs/Images.md +24 -0
- data/docs/Info.md +22 -0
- data/docs/IpBlock.md +26 -0
- data/docs/IpBlockProperties.md +26 -0
- data/docs/IpBlocks.md +24 -0
- data/docs/IpConsumer.md +30 -0
- data/docs/KubernetesApi.md +1513 -0
- data/docs/KubernetesAutoScaling.md +20 -0
- data/docs/KubernetesCluster.md +28 -0
- data/docs/KubernetesClusterEntities.md +18 -0
- data/docs/KubernetesClusterProperties.md +26 -0
- data/docs/KubernetesClusterPropertiesForPostAndPut.md +22 -0
- data/docs/KubernetesClusters.md +24 -0
- data/docs/KubernetesConfig.md +24 -0
- data/docs/KubernetesConfigProperties.md +18 -0
- data/docs/KubernetesMaintenanceWindow.md +20 -0
- data/docs/KubernetesNode.md +26 -0
- data/docs/KubernetesNodeMetadata.md +26 -0
- data/docs/KubernetesNodePool.md +26 -0
- data/docs/KubernetesNodePoolForPut.md +26 -0
- data/docs/KubernetesNodePoolLan.md +18 -0
- data/docs/KubernetesNodePoolProperties.md +50 -0
- data/docs/KubernetesNodePoolPropertiesForPost.md +48 -0
- data/docs/KubernetesNodePoolPropertiesForPut.md +48 -0
- data/docs/KubernetesNodePools.md +24 -0
- data/docs/KubernetesNodeProperties.md +22 -0
- data/docs/KubernetesNodes.md +24 -0
- data/docs/Label.md +26 -0
- data/docs/LabelApi.md +2355 -0
- data/docs/LabelProperties.md +26 -0
- data/docs/LabelResource.md +26 -0
- data/docs/LabelResourceProperties.md +20 -0
- data/docs/LabelResources.md +30 -0
- data/docs/Labels.md +24 -0
- data/docs/Lan.md +28 -0
- data/docs/LanApi.md +795 -0
- data/docs/LanEntities.md +18 -0
- data/docs/LanNics.md +30 -0
- data/docs/LanPost.md +28 -0
- data/docs/LanProperties.md +24 -0
- data/docs/LanPropertiesPost.md +24 -0
- data/docs/Lans.md +30 -0
- data/docs/LoadBalancerApi.md +883 -0
- data/docs/Loadbalancer.md +28 -0
- data/docs/LoadbalancerEntities.md +18 -0
- data/docs/LoadbalancerProperties.md +22 -0
- data/docs/Loadbalancers.md +30 -0
- data/docs/Location.md +26 -0
- data/docs/LocationApi.md +259 -0
- data/docs/LocationProperties.md +22 -0
- data/docs/Locations.md +24 -0
- data/docs/Nic.md +28 -0
- data/docs/NicApi.md +1087 -0
- data/docs/NicEntities.md +18 -0
- data/docs/NicProperties.md +30 -0
- data/docs/Nics.md +30 -0
- data/docs/NoStateMetaData.md +30 -0
- data/docs/PaginationLinks.md +22 -0
- data/docs/Peer.md +26 -0
- data/docs/PrivateCrossConnect.md +26 -0
- data/docs/PrivateCrossConnectApi.md +427 -0
- data/docs/PrivateCrossConnectProperties.md +24 -0
- data/docs/PrivateCrossConnects.md +24 -0
- data/docs/README.md +111 -0
- data/docs/Request.md +26 -0
- data/docs/RequestApi.md +267 -0
- data/docs/RequestMetadata.md +24 -0
- data/docs/RequestProperties.md +24 -0
- data/docs/RequestStatus.md +24 -0
- data/docs/RequestStatusMetadata.md +24 -0
- data/docs/RequestTarget.md +20 -0
- data/docs/Requests.md +30 -0
- data/docs/Resource.md +28 -0
- data/docs/ResourceEntities.md +18 -0
- data/docs/ResourceGroups.md +24 -0
- data/docs/ResourceLimits.md +50 -0
- data/docs/ResourceProperties.md +20 -0
- data/docs/ResourceReference.md +22 -0
- data/docs/Resources.md +24 -0
- data/docs/ResourcesUsers.md +24 -0
- data/docs/S3Key.md +26 -0
- data/docs/S3KeyMetadata.md +20 -0
- data/docs/S3KeyProperties.md +20 -0
- data/docs/S3Keys.md +24 -0
- data/docs/S3ObjectStorageSSO.md +18 -0
- data/docs/Server.md +28 -0
- data/docs/ServerApi.md +1573 -0
- data/docs/ServerEntities.md +22 -0
- data/docs/ServerProperties.md +32 -0
- data/docs/Servers.md +30 -0
- data/docs/Snapshot.md +26 -0
- data/docs/SnapshotApi.md +429 -0
- data/docs/SnapshotProperties.md +48 -0
- data/docs/Snapshots.md +24 -0
- data/docs/Type.md +15 -0
- data/docs/User.md +28 -0
- data/docs/UserManagementApi.md +2547 -0
- data/docs/UserMetadata.md +22 -0
- data/docs/UserProperties.md +34 -0
- data/docs/Users.md +24 -0
- data/docs/UsersEntities.md +20 -0
- data/docs/Volume.md +26 -0
- data/docs/VolumeApi.md +711 -0
- data/docs/VolumeProperties.md +54 -0
- data/docs/Volumes.md +30 -0
- data/docs/summary.md +295 -0
- data/gitbook.yaml +4 -0
- data/lib/ionoscloud/api/_api.rb +1 -1
- data/lib/ionoscloud/api_client.rb +1 -4
- data/lib/ionoscloud/models/backup_units.rb +2 -2
- data/lib/ionoscloud/models/datacenter_element_metadata.rb +2 -2
- data/lib/ionoscloud/models/firewallrule_properties.rb +36 -21
- data/lib/ionoscloud/models/kubernetes_node.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_node_metadata.rb +2 -2
- data/lib/ionoscloud/models/kubernetes_nodes.rb +2 -2
- data/lib/ionoscloud/models/label_resources.rb +2 -2
- data/lib/ionoscloud/models/labels.rb +2 -2
- data/lib/ionoscloud/models/loadbalancer_properties.rb +12 -29
- data/lib/ionoscloud/models/type.rb +1 -0
- data/lib/ionoscloud/models/volume_properties.rb +14 -4
- data/lib/ionoscloud/version.rb +1 -1
- data/spec/models/backup_units_spec.rb +1 -1
- data/spec/models/datacenter_element_metadata_spec.rb +1 -1
- data/spec/models/firewallrule_properties_spec.rb +0 -12
- data/spec/models/kubernetes_node_metadata_spec.rb +1 -1
- data/spec/models/kubernetes_node_spec.rb +1 -1
- data/spec/models/kubernetes_nodes_spec.rb +1 -1
- data/spec/models/label_resources_spec.rb +1 -1
- data/spec/models/labels_spec.rb +1 -1
- data/spec/models/loadbalancer_properties_spec.rb +0 -4
- data/spec/models/volume_properties_spec.rb +6 -0
- metadata +264 -120
- data/DOCS.md +0 -14618
- data/README.md +0 -55
@@ -0,0 +1,50 @@
|
|
1
|
+
# ImageProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | A name of that resource | [optional] |
|
8
|
+
| **description** | **String** | Human readable description | [optional] |
|
9
|
+
| **location** | **String** | Location of that image/snapshot. | [optional][readonly] |
|
10
|
+
| **size** | **Float** | The size of the image in GB | [optional][readonly] |
|
11
|
+
| **cpu_hot_plug** | **Boolean** | Is capable of CPU hot plug (no reboot required) | [optional] |
|
12
|
+
| **cpu_hot_unplug** | **Boolean** | Is capable of CPU hot unplug (no reboot required) | [optional] |
|
13
|
+
| **ram_hot_plug** | **Boolean** | Is capable of memory hot plug (no reboot required) | [optional] |
|
14
|
+
| **ram_hot_unplug** | **Boolean** | Is capable of memory hot unplug (no reboot required) | [optional] |
|
15
|
+
| **nic_hot_plug** | **Boolean** | Is capable of nic hot plug (no reboot required) | [optional] |
|
16
|
+
| **nic_hot_unplug** | **Boolean** | Is capable of nic hot unplug (no reboot required) | [optional] |
|
17
|
+
| **disc_virtio_hot_plug** | **Boolean** | Is capable of Virt-IO drive hot plug (no reboot required) | [optional] |
|
18
|
+
| **disc_virtio_hot_unplug** | **Boolean** | Is capable of Virt-IO drive hot unplug (no reboot required). This works only for non-Windows virtual Machines. | [optional] |
|
19
|
+
| **disc_scsi_hot_plug** | **Boolean** | Is capable of SCSI drive hot plug (no reboot required) | [optional] |
|
20
|
+
| **disc_scsi_hot_unplug** | **Boolean** | Is capable of SCSI drive hot unplug (no reboot required). This works only for non-Windows virtual Machines. | [optional] |
|
21
|
+
| **licence_type** | **String** | OS type of this Image | |
|
22
|
+
| **image_type** | **String** | This indicates the type of image | [optional][readonly] |
|
23
|
+
| **public** | **Boolean** | Indicates if the image is part of the public repository or not | [optional][readonly] |
|
24
|
+
|
25
|
+
## Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'ionoscloud'
|
29
|
+
|
30
|
+
instance = Ionoscloud::ImageProperties.new(
|
31
|
+
name: My resource,
|
32
|
+
description: Image/Snapshot of Ubuntu ,
|
33
|
+
location: us/las,
|
34
|
+
size: 100.0,
|
35
|
+
cpu_hot_plug: true,
|
36
|
+
cpu_hot_unplug: true,
|
37
|
+
ram_hot_plug: true,
|
38
|
+
ram_hot_unplug: true,
|
39
|
+
nic_hot_plug: true,
|
40
|
+
nic_hot_unplug: true,
|
41
|
+
disc_virtio_hot_plug: true,
|
42
|
+
disc_virtio_hot_unplug: true,
|
43
|
+
disc_scsi_hot_plug: true,
|
44
|
+
disc_scsi_hot_unplug: true,
|
45
|
+
licence_type: LINUX,
|
46
|
+
image_type: HDD,
|
47
|
+
public: true
|
48
|
+
)
|
49
|
+
```
|
50
|
+
|
data/docs/Images.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# Images
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **items** | [**Array<Image>**](Image.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::Images.new(
|
18
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
19
|
+
type: "collection",
|
20
|
+
href: <RESOURCE-URI>,
|
21
|
+
items: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/Info.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# Info
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **href** | **String** | API entry point | [optional][readonly] |
|
8
|
+
| **name** | **String** | Name of the API | [optional][readonly] |
|
9
|
+
| **version** | **String** | Version of the API | [optional][readonly] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ionoscloud'
|
15
|
+
|
16
|
+
instance = Ionoscloud::Info.new(
|
17
|
+
href: null,
|
18
|
+
name: CLOUD API,
|
19
|
+
version: 1.0
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/IpBlock.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# IpBlock
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) | | [optional] |
|
11
|
+
| **properties** | [**IpBlockProperties**](IpBlockProperties.md) | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ionoscloud'
|
17
|
+
|
18
|
+
instance = Ionoscloud::IpBlock.new(
|
19
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
20
|
+
type: "ipblock",
|
21
|
+
href: <RESOURCE-URI>,
|
22
|
+
metadata: null,
|
23
|
+
properties: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# IpBlockProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ips** | **Array<String>** | A collection of IPs associated with the IP Block | [optional][readonly] |
|
8
|
+
| **location** | **String** | Location of that IP Block. Property cannot be modified after creation (disallowed in update requests) | |
|
9
|
+
| **size** | **Integer** | The size of the IP block | |
|
10
|
+
| **name** | **String** | A name of that resource | [optional] |
|
11
|
+
| **ip_consumers** | [**Array<IpConsumer>**](IpConsumer.md) | Read-Only attribute. Lists consumption detail of an individual ip | [optional][readonly] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ionoscloud'
|
17
|
+
|
18
|
+
instance = Ionoscloud::IpBlockProperties.new(
|
19
|
+
ips: ["22.231.113.64", "22.231.113.65", "22.231.113.66"],
|
20
|
+
location: us/las,
|
21
|
+
size: 5,
|
22
|
+
name: My resource,
|
23
|
+
ip_consumers: { "ipConsumers": [ { "ip" : "192.18.2.11", "mac" : "02:01:3f:52:6e:57", "nicId" : "0e8ee463-1174-46f2-87ba-a5c79c14d8e5", "serverId" : "e6a3466f-8d6e-4cb6-8001-f4e245f222b7", "serverName" : "Unnamed Server", "datacenterId" : "6e54a9ec-aace-4176-8ee4-1c3a704fccfc", "datacenterName" : "IpConsumerDC"} ] }
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/IpBlocks.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# IpBlocks
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
|
+
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **items** | [**Array<IpBlock>**](IpBlock.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::IpBlocks.new(
|
18
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
19
|
+
type: "collection",
|
20
|
+
href: <RESOURCE-URI>,
|
21
|
+
items: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/IpConsumer.md
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# IpConsumer
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ip** | **String** | | [optional] |
|
8
|
+
| **mac** | **String** | | [optional] |
|
9
|
+
| **nic_id** | **String** | | [optional] |
|
10
|
+
| **server_id** | **String** | | [optional] |
|
11
|
+
| **server_name** | **String** | | [optional] |
|
12
|
+
| **datacenter_id** | **String** | | [optional] |
|
13
|
+
| **datacenter_name** | **String** | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ionoscloud'
|
19
|
+
|
20
|
+
instance = Ionoscloud::IpConsumer.new(
|
21
|
+
ip: null,
|
22
|
+
mac: null,
|
23
|
+
nic_id: null,
|
24
|
+
server_id: null,
|
25
|
+
server_name: null,
|
26
|
+
datacenter_id: null,
|
27
|
+
datacenter_name: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,1513 @@
|
|
1
|
+
# KubernetesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v5*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**k8s_delete**](KubernetesApi.md#k8s_delete) | **DELETE** /k8s/{k8sClusterId} | Delete Kubernetes Cluster |
|
8
|
+
| [**k8s_find_by_cluster_id**](KubernetesApi.md#k8s_find_by_cluster_id) | **GET** /k8s/{k8sClusterId} | Retrieve Kubernetes Cluster |
|
9
|
+
| [**k8s_get**](KubernetesApi.md#k8s_get) | **GET** /k8s | List Kubernetes Clusters |
|
10
|
+
| [**k8s_kubeconfig_get**](KubernetesApi.md#k8s_kubeconfig_get) | **GET** /k8s/{k8sClusterId}/kubeconfig | Retrieve Kubernetes Configuration File |
|
11
|
+
| [**k8s_nodepools_delete**](KubernetesApi.md#k8s_nodepools_delete) | **DELETE** /k8s/{k8sClusterId}/nodepools/{nodepoolId} | Delete Kubernetes Node Pool |
|
12
|
+
| [**k8s_nodepools_find_by_id**](KubernetesApi.md#k8s_nodepools_find_by_id) | **GET** /k8s/{k8sClusterId}/nodepools/{nodepoolId} | Retrieve Kubernetes Node Pool |
|
13
|
+
| [**k8s_nodepools_get**](KubernetesApi.md#k8s_nodepools_get) | **GET** /k8s/{k8sClusterId}/nodepools | List Kubernetes Node Pools |
|
14
|
+
| [**k8s_nodepools_nodes_delete**](KubernetesApi.md#k8s_nodepools_nodes_delete) | **DELETE** /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId} | Delete Kubernetes node |
|
15
|
+
| [**k8s_nodepools_nodes_find_by_id**](KubernetesApi.md#k8s_nodepools_nodes_find_by_id) | **GET** /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId} | Retrieve Kubernetes node |
|
16
|
+
| [**k8s_nodepools_nodes_get**](KubernetesApi.md#k8s_nodepools_nodes_get) | **GET** /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes | Retrieve Kubernetes nodes. |
|
17
|
+
| [**k8s_nodepools_nodes_replace_post**](KubernetesApi.md#k8s_nodepools_nodes_replace_post) | **POST** /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace | Recreate the Kubernetes node |
|
18
|
+
| [**k8s_nodepools_post**](KubernetesApi.md#k8s_nodepools_post) | **POST** /k8s/{k8sClusterId}/nodepools | Create a Kubernetes Node Pool |
|
19
|
+
| [**k8s_nodepools_put**](KubernetesApi.md#k8s_nodepools_put) | **PUT** /k8s/{k8sClusterId}/nodepools/{nodepoolId} | Modify Kubernetes Node Pool |
|
20
|
+
| [**k8s_post**](KubernetesApi.md#k8s_post) | **POST** /k8s | Create Kubernetes Cluster |
|
21
|
+
| [**k8s_put**](KubernetesApi.md#k8s_put) | **PUT** /k8s/{k8sClusterId} | Modify Kubernetes Cluster |
|
22
|
+
| [**k8s_versions_compatibilities_get**](KubernetesApi.md#k8s_versions_compatibilities_get) | **GET** /k8s/versions/{clusterVersion}/compatibilities | Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster. |
|
23
|
+
| [**k8s_versions_default_get**](KubernetesApi.md#k8s_versions_default_get) | **GET** /k8s/versions/default | Retrieve the current default kubernetes version for clusters and nodepools. |
|
24
|
+
| [**k8s_versions_get**](KubernetesApi.md#k8s_versions_get) | **GET** /k8s/versions | Retrieve available Kubernetes versions |
|
25
|
+
|
26
|
+
|
27
|
+
## k8s_delete
|
28
|
+
|
29
|
+
> Object k8s_delete(k8s_cluster_id, opts)
|
30
|
+
|
31
|
+
Delete Kubernetes Cluster
|
32
|
+
|
33
|
+
This will remove a Kubernetes Cluster.
|
34
|
+
|
35
|
+
### Examples
|
36
|
+
|
37
|
+
```ruby
|
38
|
+
require 'time'
|
39
|
+
require 'ionoscloud'
|
40
|
+
# setup authorization
|
41
|
+
Ionoscloud.configure do |config|
|
42
|
+
# Configure HTTP basic authorization: Basic Authentication
|
43
|
+
config.username = 'YOUR USERNAME'
|
44
|
+
config.password = 'YOUR PASSWORD'
|
45
|
+
|
46
|
+
# Configure API key authorization: Token Authentication
|
47
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
48
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
49
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
50
|
+
end
|
51
|
+
|
52
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
53
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
54
|
+
opts = {
|
55
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
56
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
57
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
58
|
+
}
|
59
|
+
|
60
|
+
begin
|
61
|
+
# Delete Kubernetes Cluster
|
62
|
+
result = api_instance.k8s_delete(k8s_cluster_id, opts)
|
63
|
+
p result
|
64
|
+
rescue Ionoscloud::ApiError => e
|
65
|
+
puts "Error when calling KubernetesApi->k8s_delete: #{e}"
|
66
|
+
end
|
67
|
+
```
|
68
|
+
|
69
|
+
#### Using the k8s_delete_with_http_info variant
|
70
|
+
|
71
|
+
This returns an Array which contains the response data, status code and headers.
|
72
|
+
|
73
|
+
> <Array(Object, Integer, Hash)> k8s_delete_with_http_info(k8s_cluster_id, opts)
|
74
|
+
|
75
|
+
```ruby
|
76
|
+
begin
|
77
|
+
# Delete Kubernetes Cluster
|
78
|
+
data, status_code, headers = api_instance.k8s_delete_with_http_info(k8s_cluster_id, opts)
|
79
|
+
p status_code # => 2xx
|
80
|
+
p headers # => { ... }
|
81
|
+
p data # => Object
|
82
|
+
rescue Ionoscloud::ApiError => e
|
83
|
+
puts "Error when calling KubernetesApi->k8s_delete_with_http_info: #{e}"
|
84
|
+
end
|
85
|
+
```
|
86
|
+
|
87
|
+
### Parameters
|
88
|
+
|
89
|
+
| Name | Type | Description | Notes |
|
90
|
+
| ---- | ---- | ----------- | ----- |
|
91
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
92
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
93
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
94
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
95
|
+
|
96
|
+
### Return type
|
97
|
+
|
98
|
+
**Object**
|
99
|
+
|
100
|
+
### Authorization
|
101
|
+
|
102
|
+
Basic Authentication, Token Authentication
|
103
|
+
|
104
|
+
### HTTP request headers
|
105
|
+
|
106
|
+
- **Content-Type**: Not defined
|
107
|
+
- **Accept**: application/json
|
108
|
+
|
109
|
+
|
110
|
+
## k8s_find_by_cluster_id
|
111
|
+
|
112
|
+
> <KubernetesCluster> k8s_find_by_cluster_id(k8s_cluster_id, opts)
|
113
|
+
|
114
|
+
Retrieve Kubernetes Cluster
|
115
|
+
|
116
|
+
This will retrieve a single Kubernetes Cluster.
|
117
|
+
|
118
|
+
### Examples
|
119
|
+
|
120
|
+
```ruby
|
121
|
+
require 'time'
|
122
|
+
require 'ionoscloud'
|
123
|
+
# setup authorization
|
124
|
+
Ionoscloud.configure do |config|
|
125
|
+
# Configure HTTP basic authorization: Basic Authentication
|
126
|
+
config.username = 'YOUR USERNAME'
|
127
|
+
config.password = 'YOUR PASSWORD'
|
128
|
+
|
129
|
+
# Configure API key authorization: Token Authentication
|
130
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
131
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
132
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
133
|
+
end
|
134
|
+
|
135
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
136
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
137
|
+
opts = {
|
138
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
139
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
140
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
141
|
+
}
|
142
|
+
|
143
|
+
begin
|
144
|
+
# Retrieve Kubernetes Cluster
|
145
|
+
result = api_instance.k8s_find_by_cluster_id(k8s_cluster_id, opts)
|
146
|
+
p result
|
147
|
+
rescue Ionoscloud::ApiError => e
|
148
|
+
puts "Error when calling KubernetesApi->k8s_find_by_cluster_id: #{e}"
|
149
|
+
end
|
150
|
+
```
|
151
|
+
|
152
|
+
#### Using the k8s_find_by_cluster_id_with_http_info variant
|
153
|
+
|
154
|
+
This returns an Array which contains the response data, status code and headers.
|
155
|
+
|
156
|
+
> <Array(<KubernetesCluster>, Integer, Hash)> k8s_find_by_cluster_id_with_http_info(k8s_cluster_id, opts)
|
157
|
+
|
158
|
+
```ruby
|
159
|
+
begin
|
160
|
+
# Retrieve Kubernetes Cluster
|
161
|
+
data, status_code, headers = api_instance.k8s_find_by_cluster_id_with_http_info(k8s_cluster_id, opts)
|
162
|
+
p status_code # => 2xx
|
163
|
+
p headers # => { ... }
|
164
|
+
p data # => <KubernetesCluster>
|
165
|
+
rescue Ionoscloud::ApiError => e
|
166
|
+
puts "Error when calling KubernetesApi->k8s_find_by_cluster_id_with_http_info: #{e}"
|
167
|
+
end
|
168
|
+
```
|
169
|
+
|
170
|
+
### Parameters
|
171
|
+
|
172
|
+
| Name | Type | Description | Notes |
|
173
|
+
| ---- | ---- | ----------- | ----- |
|
174
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
175
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
176
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
177
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
178
|
+
|
179
|
+
### Return type
|
180
|
+
|
181
|
+
[**KubernetesCluster**](KubernetesCluster.md)
|
182
|
+
|
183
|
+
### Authorization
|
184
|
+
|
185
|
+
Basic Authentication, Token Authentication
|
186
|
+
|
187
|
+
### HTTP request headers
|
188
|
+
|
189
|
+
- **Content-Type**: Not defined
|
190
|
+
- **Accept**: application/json
|
191
|
+
|
192
|
+
|
193
|
+
## k8s_get
|
194
|
+
|
195
|
+
> <KubernetesClusters> k8s_get(opts)
|
196
|
+
|
197
|
+
List Kubernetes Clusters
|
198
|
+
|
199
|
+
You can retrieve a list of all kubernetes clusters associated with a contract
|
200
|
+
|
201
|
+
### Examples
|
202
|
+
|
203
|
+
```ruby
|
204
|
+
require 'time'
|
205
|
+
require 'ionoscloud'
|
206
|
+
# setup authorization
|
207
|
+
Ionoscloud.configure do |config|
|
208
|
+
# Configure HTTP basic authorization: Basic Authentication
|
209
|
+
config.username = 'YOUR USERNAME'
|
210
|
+
config.password = 'YOUR PASSWORD'
|
211
|
+
|
212
|
+
# Configure API key authorization: Token Authentication
|
213
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
214
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
215
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
216
|
+
end
|
217
|
+
|
218
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
219
|
+
opts = {
|
220
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
221
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
222
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
223
|
+
}
|
224
|
+
|
225
|
+
begin
|
226
|
+
# List Kubernetes Clusters
|
227
|
+
result = api_instance.k8s_get(opts)
|
228
|
+
p result
|
229
|
+
rescue Ionoscloud::ApiError => e
|
230
|
+
puts "Error when calling KubernetesApi->k8s_get: #{e}"
|
231
|
+
end
|
232
|
+
```
|
233
|
+
|
234
|
+
#### Using the k8s_get_with_http_info variant
|
235
|
+
|
236
|
+
This returns an Array which contains the response data, status code and headers.
|
237
|
+
|
238
|
+
> <Array(<KubernetesClusters>, Integer, Hash)> k8s_get_with_http_info(opts)
|
239
|
+
|
240
|
+
```ruby
|
241
|
+
begin
|
242
|
+
# List Kubernetes Clusters
|
243
|
+
data, status_code, headers = api_instance.k8s_get_with_http_info(opts)
|
244
|
+
p status_code # => 2xx
|
245
|
+
p headers # => { ... }
|
246
|
+
p data # => <KubernetesClusters>
|
247
|
+
rescue Ionoscloud::ApiError => e
|
248
|
+
puts "Error when calling KubernetesApi->k8s_get_with_http_info: #{e}"
|
249
|
+
end
|
250
|
+
```
|
251
|
+
|
252
|
+
### Parameters
|
253
|
+
|
254
|
+
| Name | Type | Description | Notes |
|
255
|
+
| ---- | ---- | ----------- | ----- |
|
256
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
257
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
258
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
259
|
+
|
260
|
+
### Return type
|
261
|
+
|
262
|
+
[**KubernetesClusters**](KubernetesClusters.md)
|
263
|
+
|
264
|
+
### Authorization
|
265
|
+
|
266
|
+
Basic Authentication, Token Authentication
|
267
|
+
|
268
|
+
### HTTP request headers
|
269
|
+
|
270
|
+
- **Content-Type**: Not defined
|
271
|
+
- **Accept**: application/json
|
272
|
+
|
273
|
+
|
274
|
+
## k8s_kubeconfig_get
|
275
|
+
|
276
|
+
> <KubernetesConfig> k8s_kubeconfig_get(k8s_cluster_id, opts)
|
277
|
+
|
278
|
+
Retrieve Kubernetes Configuration File
|
279
|
+
|
280
|
+
You can retrieve kubernetes configuration file for the kubernetes cluster.
|
281
|
+
|
282
|
+
### Examples
|
283
|
+
|
284
|
+
```ruby
|
285
|
+
require 'time'
|
286
|
+
require 'ionoscloud'
|
287
|
+
# setup authorization
|
288
|
+
Ionoscloud.configure do |config|
|
289
|
+
# Configure HTTP basic authorization: Basic Authentication
|
290
|
+
config.username = 'YOUR USERNAME'
|
291
|
+
config.password = 'YOUR PASSWORD'
|
292
|
+
|
293
|
+
# Configure API key authorization: Token Authentication
|
294
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
295
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
296
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
297
|
+
end
|
298
|
+
|
299
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
300
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
301
|
+
opts = {
|
302
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
303
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
304
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
305
|
+
}
|
306
|
+
|
307
|
+
begin
|
308
|
+
# Retrieve Kubernetes Configuration File
|
309
|
+
result = api_instance.k8s_kubeconfig_get(k8s_cluster_id, opts)
|
310
|
+
p result
|
311
|
+
rescue Ionoscloud::ApiError => e
|
312
|
+
puts "Error when calling KubernetesApi->k8s_kubeconfig_get: #{e}"
|
313
|
+
end
|
314
|
+
```
|
315
|
+
|
316
|
+
#### Using the k8s_kubeconfig_get_with_http_info variant
|
317
|
+
|
318
|
+
This returns an Array which contains the response data, status code and headers.
|
319
|
+
|
320
|
+
> <Array(<KubernetesConfig>, Integer, Hash)> k8s_kubeconfig_get_with_http_info(k8s_cluster_id, opts)
|
321
|
+
|
322
|
+
```ruby
|
323
|
+
begin
|
324
|
+
# Retrieve Kubernetes Configuration File
|
325
|
+
data, status_code, headers = api_instance.k8s_kubeconfig_get_with_http_info(k8s_cluster_id, opts)
|
326
|
+
p status_code # => 2xx
|
327
|
+
p headers # => { ... }
|
328
|
+
p data # => <KubernetesConfig>
|
329
|
+
rescue Ionoscloud::ApiError => e
|
330
|
+
puts "Error when calling KubernetesApi->k8s_kubeconfig_get_with_http_info: #{e}"
|
331
|
+
end
|
332
|
+
```
|
333
|
+
|
334
|
+
### Parameters
|
335
|
+
|
336
|
+
| Name | Type | Description | Notes |
|
337
|
+
| ---- | ---- | ----------- | ----- |
|
338
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
339
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
340
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
341
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
342
|
+
|
343
|
+
### Return type
|
344
|
+
|
345
|
+
[**KubernetesConfig**](KubernetesConfig.md)
|
346
|
+
|
347
|
+
### Authorization
|
348
|
+
|
349
|
+
Basic Authentication, Token Authentication
|
350
|
+
|
351
|
+
### HTTP request headers
|
352
|
+
|
353
|
+
- **Content-Type**: Not defined
|
354
|
+
- **Accept**: application/json
|
355
|
+
|
356
|
+
|
357
|
+
## k8s_nodepools_delete
|
358
|
+
|
359
|
+
> Object k8s_nodepools_delete(k8s_cluster_id, nodepool_id, opts)
|
360
|
+
|
361
|
+
Delete Kubernetes Node Pool
|
362
|
+
|
363
|
+
This will remove a Kubernetes Node Pool.
|
364
|
+
|
365
|
+
### Examples
|
366
|
+
|
367
|
+
```ruby
|
368
|
+
require 'time'
|
369
|
+
require 'ionoscloud'
|
370
|
+
# setup authorization
|
371
|
+
Ionoscloud.configure do |config|
|
372
|
+
# Configure HTTP basic authorization: Basic Authentication
|
373
|
+
config.username = 'YOUR USERNAME'
|
374
|
+
config.password = 'YOUR PASSWORD'
|
375
|
+
|
376
|
+
# Configure API key authorization: Token Authentication
|
377
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
378
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
379
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
380
|
+
end
|
381
|
+
|
382
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
383
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
384
|
+
nodepool_id = 'nodepool_id_example' # String | The unique ID of the Kubernetes Node Pool
|
385
|
+
opts = {
|
386
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
387
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
388
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
389
|
+
}
|
390
|
+
|
391
|
+
begin
|
392
|
+
# Delete Kubernetes Node Pool
|
393
|
+
result = api_instance.k8s_nodepools_delete(k8s_cluster_id, nodepool_id, opts)
|
394
|
+
p result
|
395
|
+
rescue Ionoscloud::ApiError => e
|
396
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_delete: #{e}"
|
397
|
+
end
|
398
|
+
```
|
399
|
+
|
400
|
+
#### Using the k8s_nodepools_delete_with_http_info variant
|
401
|
+
|
402
|
+
This returns an Array which contains the response data, status code and headers.
|
403
|
+
|
404
|
+
> <Array(Object, Integer, Hash)> k8s_nodepools_delete_with_http_info(k8s_cluster_id, nodepool_id, opts)
|
405
|
+
|
406
|
+
```ruby
|
407
|
+
begin
|
408
|
+
# Delete Kubernetes Node Pool
|
409
|
+
data, status_code, headers = api_instance.k8s_nodepools_delete_with_http_info(k8s_cluster_id, nodepool_id, opts)
|
410
|
+
p status_code # => 2xx
|
411
|
+
p headers # => { ... }
|
412
|
+
p data # => Object
|
413
|
+
rescue Ionoscloud::ApiError => e
|
414
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_delete_with_http_info: #{e}"
|
415
|
+
end
|
416
|
+
```
|
417
|
+
|
418
|
+
### Parameters
|
419
|
+
|
420
|
+
| Name | Type | Description | Notes |
|
421
|
+
| ---- | ---- | ----------- | ----- |
|
422
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
423
|
+
| **nodepool_id** | **String** | The unique ID of the Kubernetes Node Pool | |
|
424
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
425
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
426
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
427
|
+
|
428
|
+
### Return type
|
429
|
+
|
430
|
+
**Object**
|
431
|
+
|
432
|
+
### Authorization
|
433
|
+
|
434
|
+
Basic Authentication, Token Authentication
|
435
|
+
|
436
|
+
### HTTP request headers
|
437
|
+
|
438
|
+
- **Content-Type**: Not defined
|
439
|
+
- **Accept**: application/json
|
440
|
+
|
441
|
+
|
442
|
+
## k8s_nodepools_find_by_id
|
443
|
+
|
444
|
+
> <KubernetesNodePool> k8s_nodepools_find_by_id(k8s_cluster_id, nodepool_id, opts)
|
445
|
+
|
446
|
+
Retrieve Kubernetes Node Pool
|
447
|
+
|
448
|
+
You can retrieve a single Kubernetes Node Pool.
|
449
|
+
|
450
|
+
### Examples
|
451
|
+
|
452
|
+
```ruby
|
453
|
+
require 'time'
|
454
|
+
require 'ionoscloud'
|
455
|
+
# setup authorization
|
456
|
+
Ionoscloud.configure do |config|
|
457
|
+
# Configure HTTP basic authorization: Basic Authentication
|
458
|
+
config.username = 'YOUR USERNAME'
|
459
|
+
config.password = 'YOUR PASSWORD'
|
460
|
+
|
461
|
+
# Configure API key authorization: Token Authentication
|
462
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
463
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
464
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
465
|
+
end
|
466
|
+
|
467
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
468
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
469
|
+
nodepool_id = 'nodepool_id_example' # String | The unique ID of the Kubernetes Node Pool
|
470
|
+
opts = {
|
471
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
472
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
473
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
474
|
+
}
|
475
|
+
|
476
|
+
begin
|
477
|
+
# Retrieve Kubernetes Node Pool
|
478
|
+
result = api_instance.k8s_nodepools_find_by_id(k8s_cluster_id, nodepool_id, opts)
|
479
|
+
p result
|
480
|
+
rescue Ionoscloud::ApiError => e
|
481
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_find_by_id: #{e}"
|
482
|
+
end
|
483
|
+
```
|
484
|
+
|
485
|
+
#### Using the k8s_nodepools_find_by_id_with_http_info variant
|
486
|
+
|
487
|
+
This returns an Array which contains the response data, status code and headers.
|
488
|
+
|
489
|
+
> <Array(<KubernetesNodePool>, Integer, Hash)> k8s_nodepools_find_by_id_with_http_info(k8s_cluster_id, nodepool_id, opts)
|
490
|
+
|
491
|
+
```ruby
|
492
|
+
begin
|
493
|
+
# Retrieve Kubernetes Node Pool
|
494
|
+
data, status_code, headers = api_instance.k8s_nodepools_find_by_id_with_http_info(k8s_cluster_id, nodepool_id, opts)
|
495
|
+
p status_code # => 2xx
|
496
|
+
p headers # => { ... }
|
497
|
+
p data # => <KubernetesNodePool>
|
498
|
+
rescue Ionoscloud::ApiError => e
|
499
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_find_by_id_with_http_info: #{e}"
|
500
|
+
end
|
501
|
+
```
|
502
|
+
|
503
|
+
### Parameters
|
504
|
+
|
505
|
+
| Name | Type | Description | Notes |
|
506
|
+
| ---- | ---- | ----------- | ----- |
|
507
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
508
|
+
| **nodepool_id** | **String** | The unique ID of the Kubernetes Node Pool | |
|
509
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
510
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
511
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
512
|
+
|
513
|
+
### Return type
|
514
|
+
|
515
|
+
[**KubernetesNodePool**](KubernetesNodePool.md)
|
516
|
+
|
517
|
+
### Authorization
|
518
|
+
|
519
|
+
Basic Authentication, Token Authentication
|
520
|
+
|
521
|
+
### HTTP request headers
|
522
|
+
|
523
|
+
- **Content-Type**: Not defined
|
524
|
+
- **Accept**: application/json
|
525
|
+
|
526
|
+
|
527
|
+
## k8s_nodepools_get
|
528
|
+
|
529
|
+
> <KubernetesNodePools> k8s_nodepools_get(k8s_cluster_id, opts)
|
530
|
+
|
531
|
+
List Kubernetes Node Pools
|
532
|
+
|
533
|
+
You can retrieve a list of all kubernetes node pools part of kubernetes cluster
|
534
|
+
|
535
|
+
### Examples
|
536
|
+
|
537
|
+
```ruby
|
538
|
+
require 'time'
|
539
|
+
require 'ionoscloud'
|
540
|
+
# setup authorization
|
541
|
+
Ionoscloud.configure do |config|
|
542
|
+
# Configure HTTP basic authorization: Basic Authentication
|
543
|
+
config.username = 'YOUR USERNAME'
|
544
|
+
config.password = 'YOUR PASSWORD'
|
545
|
+
|
546
|
+
# Configure API key authorization: Token Authentication
|
547
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
548
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
549
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
550
|
+
end
|
551
|
+
|
552
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
553
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
554
|
+
opts = {
|
555
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
556
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
557
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
558
|
+
}
|
559
|
+
|
560
|
+
begin
|
561
|
+
# List Kubernetes Node Pools
|
562
|
+
result = api_instance.k8s_nodepools_get(k8s_cluster_id, opts)
|
563
|
+
p result
|
564
|
+
rescue Ionoscloud::ApiError => e
|
565
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_get: #{e}"
|
566
|
+
end
|
567
|
+
```
|
568
|
+
|
569
|
+
#### Using the k8s_nodepools_get_with_http_info variant
|
570
|
+
|
571
|
+
This returns an Array which contains the response data, status code and headers.
|
572
|
+
|
573
|
+
> <Array(<KubernetesNodePools>, Integer, Hash)> k8s_nodepools_get_with_http_info(k8s_cluster_id, opts)
|
574
|
+
|
575
|
+
```ruby
|
576
|
+
begin
|
577
|
+
# List Kubernetes Node Pools
|
578
|
+
data, status_code, headers = api_instance.k8s_nodepools_get_with_http_info(k8s_cluster_id, opts)
|
579
|
+
p status_code # => 2xx
|
580
|
+
p headers # => { ... }
|
581
|
+
p data # => <KubernetesNodePools>
|
582
|
+
rescue Ionoscloud::ApiError => e
|
583
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_get_with_http_info: #{e}"
|
584
|
+
end
|
585
|
+
```
|
586
|
+
|
587
|
+
### Parameters
|
588
|
+
|
589
|
+
| Name | Type | Description | Notes |
|
590
|
+
| ---- | ---- | ----------- | ----- |
|
591
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
592
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
593
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
594
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
595
|
+
|
596
|
+
### Return type
|
597
|
+
|
598
|
+
[**KubernetesNodePools**](KubernetesNodePools.md)
|
599
|
+
|
600
|
+
### Authorization
|
601
|
+
|
602
|
+
Basic Authentication, Token Authentication
|
603
|
+
|
604
|
+
### HTTP request headers
|
605
|
+
|
606
|
+
- **Content-Type**: Not defined
|
607
|
+
- **Accept**: application/json
|
608
|
+
|
609
|
+
|
610
|
+
## k8s_nodepools_nodes_delete
|
611
|
+
|
612
|
+
> Object k8s_nodepools_nodes_delete(k8s_cluster_id, nodepool_id, node_id, opts)
|
613
|
+
|
614
|
+
Delete Kubernetes node
|
615
|
+
|
616
|
+
This will remove a Kubernetes node.
|
617
|
+
|
618
|
+
### Examples
|
619
|
+
|
620
|
+
```ruby
|
621
|
+
require 'time'
|
622
|
+
require 'ionoscloud'
|
623
|
+
# setup authorization
|
624
|
+
Ionoscloud.configure do |config|
|
625
|
+
# Configure HTTP basic authorization: Basic Authentication
|
626
|
+
config.username = 'YOUR USERNAME'
|
627
|
+
config.password = 'YOUR PASSWORD'
|
628
|
+
|
629
|
+
# Configure API key authorization: Token Authentication
|
630
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
631
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
632
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
633
|
+
end
|
634
|
+
|
635
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
636
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
637
|
+
nodepool_id = 'nodepool_id_example' # String | The unique ID of the Kubernetes Node Pool
|
638
|
+
node_id = 'node_id_example' # String | The unique ID of the Kubernetes node
|
639
|
+
opts = {
|
640
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
641
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
642
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
643
|
+
}
|
644
|
+
|
645
|
+
begin
|
646
|
+
# Delete Kubernetes node
|
647
|
+
result = api_instance.k8s_nodepools_nodes_delete(k8s_cluster_id, nodepool_id, node_id, opts)
|
648
|
+
p result
|
649
|
+
rescue Ionoscloud::ApiError => e
|
650
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_nodes_delete: #{e}"
|
651
|
+
end
|
652
|
+
```
|
653
|
+
|
654
|
+
#### Using the k8s_nodepools_nodes_delete_with_http_info variant
|
655
|
+
|
656
|
+
This returns an Array which contains the response data, status code and headers.
|
657
|
+
|
658
|
+
> <Array(Object, Integer, Hash)> k8s_nodepools_nodes_delete_with_http_info(k8s_cluster_id, nodepool_id, node_id, opts)
|
659
|
+
|
660
|
+
```ruby
|
661
|
+
begin
|
662
|
+
# Delete Kubernetes node
|
663
|
+
data, status_code, headers = api_instance.k8s_nodepools_nodes_delete_with_http_info(k8s_cluster_id, nodepool_id, node_id, opts)
|
664
|
+
p status_code # => 2xx
|
665
|
+
p headers # => { ... }
|
666
|
+
p data # => Object
|
667
|
+
rescue Ionoscloud::ApiError => e
|
668
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_nodes_delete_with_http_info: #{e}"
|
669
|
+
end
|
670
|
+
```
|
671
|
+
|
672
|
+
### Parameters
|
673
|
+
|
674
|
+
| Name | Type | Description | Notes |
|
675
|
+
| ---- | ---- | ----------- | ----- |
|
676
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
677
|
+
| **nodepool_id** | **String** | The unique ID of the Kubernetes Node Pool | |
|
678
|
+
| **node_id** | **String** | The unique ID of the Kubernetes node | |
|
679
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
680
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
681
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
682
|
+
|
683
|
+
### Return type
|
684
|
+
|
685
|
+
**Object**
|
686
|
+
|
687
|
+
### Authorization
|
688
|
+
|
689
|
+
Basic Authentication, Token Authentication
|
690
|
+
|
691
|
+
### HTTP request headers
|
692
|
+
|
693
|
+
- **Content-Type**: Not defined
|
694
|
+
- **Accept**: application/json
|
695
|
+
|
696
|
+
|
697
|
+
## k8s_nodepools_nodes_find_by_id
|
698
|
+
|
699
|
+
> <KubernetesNode> k8s_nodepools_nodes_find_by_id(k8s_cluster_id, nodepool_id, node_id, opts)
|
700
|
+
|
701
|
+
Retrieve Kubernetes node
|
702
|
+
|
703
|
+
You can retrieve a single Kubernetes Node.
|
704
|
+
|
705
|
+
### Examples
|
706
|
+
|
707
|
+
```ruby
|
708
|
+
require 'time'
|
709
|
+
require 'ionoscloud'
|
710
|
+
# setup authorization
|
711
|
+
Ionoscloud.configure do |config|
|
712
|
+
# Configure HTTP basic authorization: Basic Authentication
|
713
|
+
config.username = 'YOUR USERNAME'
|
714
|
+
config.password = 'YOUR PASSWORD'
|
715
|
+
|
716
|
+
# Configure API key authorization: Token Authentication
|
717
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
718
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
719
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
720
|
+
end
|
721
|
+
|
722
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
723
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
724
|
+
nodepool_id = 'nodepool_id_example' # String | The unique ID of the Kubernetes Node Pool
|
725
|
+
node_id = 'node_id_example' # String | The unique ID of the Kubernetes Node.
|
726
|
+
opts = {
|
727
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
728
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
729
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
730
|
+
}
|
731
|
+
|
732
|
+
begin
|
733
|
+
# Retrieve Kubernetes node
|
734
|
+
result = api_instance.k8s_nodepools_nodes_find_by_id(k8s_cluster_id, nodepool_id, node_id, opts)
|
735
|
+
p result
|
736
|
+
rescue Ionoscloud::ApiError => e
|
737
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_nodes_find_by_id: #{e}"
|
738
|
+
end
|
739
|
+
```
|
740
|
+
|
741
|
+
#### Using the k8s_nodepools_nodes_find_by_id_with_http_info variant
|
742
|
+
|
743
|
+
This returns an Array which contains the response data, status code and headers.
|
744
|
+
|
745
|
+
> <Array(<KubernetesNode>, Integer, Hash)> k8s_nodepools_nodes_find_by_id_with_http_info(k8s_cluster_id, nodepool_id, node_id, opts)
|
746
|
+
|
747
|
+
```ruby
|
748
|
+
begin
|
749
|
+
# Retrieve Kubernetes node
|
750
|
+
data, status_code, headers = api_instance.k8s_nodepools_nodes_find_by_id_with_http_info(k8s_cluster_id, nodepool_id, node_id, opts)
|
751
|
+
p status_code # => 2xx
|
752
|
+
p headers # => { ... }
|
753
|
+
p data # => <KubernetesNode>
|
754
|
+
rescue Ionoscloud::ApiError => e
|
755
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_nodes_find_by_id_with_http_info: #{e}"
|
756
|
+
end
|
757
|
+
```
|
758
|
+
|
759
|
+
### Parameters
|
760
|
+
|
761
|
+
| Name | Type | Description | Notes |
|
762
|
+
| ---- | ---- | ----------- | ----- |
|
763
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
764
|
+
| **nodepool_id** | **String** | The unique ID of the Kubernetes Node Pool | |
|
765
|
+
| **node_id** | **String** | The unique ID of the Kubernetes Node. | |
|
766
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
767
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
768
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
769
|
+
|
770
|
+
### Return type
|
771
|
+
|
772
|
+
[**KubernetesNode**](KubernetesNode.md)
|
773
|
+
|
774
|
+
### Authorization
|
775
|
+
|
776
|
+
Basic Authentication, Token Authentication
|
777
|
+
|
778
|
+
### HTTP request headers
|
779
|
+
|
780
|
+
- **Content-Type**: Not defined
|
781
|
+
- **Accept**: application/json
|
782
|
+
|
783
|
+
|
784
|
+
## k8s_nodepools_nodes_get
|
785
|
+
|
786
|
+
> <KubernetesNodes> k8s_nodepools_nodes_get(k8s_cluster_id, nodepool_id, opts)
|
787
|
+
|
788
|
+
Retrieve Kubernetes nodes.
|
789
|
+
|
790
|
+
You can retrieve all nodes of Kubernetes Node Pool.
|
791
|
+
|
792
|
+
### Examples
|
793
|
+
|
794
|
+
```ruby
|
795
|
+
require 'time'
|
796
|
+
require 'ionoscloud'
|
797
|
+
# setup authorization
|
798
|
+
Ionoscloud.configure do |config|
|
799
|
+
# Configure HTTP basic authorization: Basic Authentication
|
800
|
+
config.username = 'YOUR USERNAME'
|
801
|
+
config.password = 'YOUR PASSWORD'
|
802
|
+
|
803
|
+
# Configure API key authorization: Token Authentication
|
804
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
805
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
806
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
807
|
+
end
|
808
|
+
|
809
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
810
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
811
|
+
nodepool_id = 'nodepool_id_example' # String | The unique ID of the Kubernetes Node Pool
|
812
|
+
opts = {
|
813
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
814
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
815
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
816
|
+
}
|
817
|
+
|
818
|
+
begin
|
819
|
+
# Retrieve Kubernetes nodes.
|
820
|
+
result = api_instance.k8s_nodepools_nodes_get(k8s_cluster_id, nodepool_id, opts)
|
821
|
+
p result
|
822
|
+
rescue Ionoscloud::ApiError => e
|
823
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_nodes_get: #{e}"
|
824
|
+
end
|
825
|
+
```
|
826
|
+
|
827
|
+
#### Using the k8s_nodepools_nodes_get_with_http_info variant
|
828
|
+
|
829
|
+
This returns an Array which contains the response data, status code and headers.
|
830
|
+
|
831
|
+
> <Array(<KubernetesNodes>, Integer, Hash)> k8s_nodepools_nodes_get_with_http_info(k8s_cluster_id, nodepool_id, opts)
|
832
|
+
|
833
|
+
```ruby
|
834
|
+
begin
|
835
|
+
# Retrieve Kubernetes nodes.
|
836
|
+
data, status_code, headers = api_instance.k8s_nodepools_nodes_get_with_http_info(k8s_cluster_id, nodepool_id, opts)
|
837
|
+
p status_code # => 2xx
|
838
|
+
p headers # => { ... }
|
839
|
+
p data # => <KubernetesNodes>
|
840
|
+
rescue Ionoscloud::ApiError => e
|
841
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_nodes_get_with_http_info: #{e}"
|
842
|
+
end
|
843
|
+
```
|
844
|
+
|
845
|
+
### Parameters
|
846
|
+
|
847
|
+
| Name | Type | Description | Notes |
|
848
|
+
| ---- | ---- | ----------- | ----- |
|
849
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
850
|
+
| **nodepool_id** | **String** | The unique ID of the Kubernetes Node Pool | |
|
851
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
852
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
853
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
854
|
+
|
855
|
+
### Return type
|
856
|
+
|
857
|
+
[**KubernetesNodes**](KubernetesNodes.md)
|
858
|
+
|
859
|
+
### Authorization
|
860
|
+
|
861
|
+
Basic Authentication, Token Authentication
|
862
|
+
|
863
|
+
### HTTP request headers
|
864
|
+
|
865
|
+
- **Content-Type**: Not defined
|
866
|
+
- **Accept**: application/json
|
867
|
+
|
868
|
+
|
869
|
+
## k8s_nodepools_nodes_replace_post
|
870
|
+
|
871
|
+
> Object k8s_nodepools_nodes_replace_post(k8s_cluster_id, nodepool_id, node_id, opts)
|
872
|
+
|
873
|
+
Recreate the Kubernetes node
|
874
|
+
|
875
|
+
You can recreate a single Kubernetes Node. Managed Kubernetes starts a process which based on the nodepool's template creates & configures a new node, waits for status \"ACTIVE\", and migrates all the pods from the faulty node, deleting it once empty. While this operation occurs, the nodepool will have an extra billable \"ACTIVE\" node.
|
876
|
+
|
877
|
+
### Examples
|
878
|
+
|
879
|
+
```ruby
|
880
|
+
require 'time'
|
881
|
+
require 'ionoscloud'
|
882
|
+
# setup authorization
|
883
|
+
Ionoscloud.configure do |config|
|
884
|
+
# Configure HTTP basic authorization: Basic Authentication
|
885
|
+
config.username = 'YOUR USERNAME'
|
886
|
+
config.password = 'YOUR PASSWORD'
|
887
|
+
|
888
|
+
# Configure API key authorization: Token Authentication
|
889
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
890
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
891
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
892
|
+
end
|
893
|
+
|
894
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
895
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
896
|
+
nodepool_id = 'nodepool_id_example' # String | The unique ID of the Kubernetes Node Pool
|
897
|
+
node_id = 'node_id_example' # String | The unique ID of the Kubernetes Node.
|
898
|
+
opts = {
|
899
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
900
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
901
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
902
|
+
}
|
903
|
+
|
904
|
+
begin
|
905
|
+
# Recreate the Kubernetes node
|
906
|
+
result = api_instance.k8s_nodepools_nodes_replace_post(k8s_cluster_id, nodepool_id, node_id, opts)
|
907
|
+
p result
|
908
|
+
rescue Ionoscloud::ApiError => e
|
909
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_nodes_replace_post: #{e}"
|
910
|
+
end
|
911
|
+
```
|
912
|
+
|
913
|
+
#### Using the k8s_nodepools_nodes_replace_post_with_http_info variant
|
914
|
+
|
915
|
+
This returns an Array which contains the response data, status code and headers.
|
916
|
+
|
917
|
+
> <Array(Object, Integer, Hash)> k8s_nodepools_nodes_replace_post_with_http_info(k8s_cluster_id, nodepool_id, node_id, opts)
|
918
|
+
|
919
|
+
```ruby
|
920
|
+
begin
|
921
|
+
# Recreate the Kubernetes node
|
922
|
+
data, status_code, headers = api_instance.k8s_nodepools_nodes_replace_post_with_http_info(k8s_cluster_id, nodepool_id, node_id, opts)
|
923
|
+
p status_code # => 2xx
|
924
|
+
p headers # => { ... }
|
925
|
+
p data # => Object
|
926
|
+
rescue Ionoscloud::ApiError => e
|
927
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_nodes_replace_post_with_http_info: #{e}"
|
928
|
+
end
|
929
|
+
```
|
930
|
+
|
931
|
+
### Parameters
|
932
|
+
|
933
|
+
| Name | Type | Description | Notes |
|
934
|
+
| ---- | ---- | ----------- | ----- |
|
935
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
936
|
+
| **nodepool_id** | **String** | The unique ID of the Kubernetes Node Pool | |
|
937
|
+
| **node_id** | **String** | The unique ID of the Kubernetes Node. | |
|
938
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
939
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
940
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
941
|
+
|
942
|
+
### Return type
|
943
|
+
|
944
|
+
**Object**
|
945
|
+
|
946
|
+
### Authorization
|
947
|
+
|
948
|
+
Basic Authentication, Token Authentication
|
949
|
+
|
950
|
+
### HTTP request headers
|
951
|
+
|
952
|
+
- **Content-Type**: Not defined
|
953
|
+
- **Accept**: application/json
|
954
|
+
|
955
|
+
|
956
|
+
## k8s_nodepools_post
|
957
|
+
|
958
|
+
> <KubernetesNodePool> k8s_nodepools_post(k8s_cluster_id, kubernetes_node_pool, opts)
|
959
|
+
|
960
|
+
Create a Kubernetes Node Pool
|
961
|
+
|
962
|
+
This will create a new Kubernetes Node Pool inside a Kubernetes Cluster.
|
963
|
+
|
964
|
+
### Examples
|
965
|
+
|
966
|
+
```ruby
|
967
|
+
require 'time'
|
968
|
+
require 'ionoscloud'
|
969
|
+
# setup authorization
|
970
|
+
Ionoscloud.configure do |config|
|
971
|
+
# Configure HTTP basic authorization: Basic Authentication
|
972
|
+
config.username = 'YOUR USERNAME'
|
973
|
+
config.password = 'YOUR PASSWORD'
|
974
|
+
|
975
|
+
# Configure API key authorization: Token Authentication
|
976
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
977
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
978
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
979
|
+
end
|
980
|
+
|
981
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
982
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
983
|
+
kubernetes_node_pool = Ionoscloud::KubernetesNodePool.new({properties: Ionoscloud::KubernetesNodePoolProperties.new({name: 'k8s-node-pool', datacenter_id: '1e072e52-2ed3-492f-b6b6-c6b116907521', node_count: 2, cpu_family: 'AMD_OPTERON', cores_count: 4, ram_size: 2048, availability_zone: 'AUTO', storage_type: 'HDD', storage_size: 100})}) # KubernetesNodePool | Details of Kubernetes Node Pool
|
984
|
+
opts = {
|
985
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
986
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
987
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
988
|
+
}
|
989
|
+
|
990
|
+
begin
|
991
|
+
# Create a Kubernetes Node Pool
|
992
|
+
result = api_instance.k8s_nodepools_post(k8s_cluster_id, kubernetes_node_pool, opts)
|
993
|
+
p result
|
994
|
+
rescue Ionoscloud::ApiError => e
|
995
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_post: #{e}"
|
996
|
+
end
|
997
|
+
```
|
998
|
+
|
999
|
+
#### Using the k8s_nodepools_post_with_http_info variant
|
1000
|
+
|
1001
|
+
This returns an Array which contains the response data, status code and headers.
|
1002
|
+
|
1003
|
+
> <Array(<KubernetesNodePool>, Integer, Hash)> k8s_nodepools_post_with_http_info(k8s_cluster_id, kubernetes_node_pool, opts)
|
1004
|
+
|
1005
|
+
```ruby
|
1006
|
+
begin
|
1007
|
+
# Create a Kubernetes Node Pool
|
1008
|
+
data, status_code, headers = api_instance.k8s_nodepools_post_with_http_info(k8s_cluster_id, kubernetes_node_pool, opts)
|
1009
|
+
p status_code # => 2xx
|
1010
|
+
p headers # => { ... }
|
1011
|
+
p data # => <KubernetesNodePool>
|
1012
|
+
rescue Ionoscloud::ApiError => e
|
1013
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_post_with_http_info: #{e}"
|
1014
|
+
end
|
1015
|
+
```
|
1016
|
+
|
1017
|
+
### Parameters
|
1018
|
+
|
1019
|
+
| Name | Type | Description | Notes |
|
1020
|
+
| ---- | ---- | ----------- | ----- |
|
1021
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
1022
|
+
| **kubernetes_node_pool** | [**KubernetesNodePool**](KubernetesNodePool.md) | Details of Kubernetes Node Pool | |
|
1023
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
1024
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
1025
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
1026
|
+
|
1027
|
+
### Return type
|
1028
|
+
|
1029
|
+
[**KubernetesNodePool**](KubernetesNodePool.md)
|
1030
|
+
|
1031
|
+
### Authorization
|
1032
|
+
|
1033
|
+
Basic Authentication, Token Authentication
|
1034
|
+
|
1035
|
+
### HTTP request headers
|
1036
|
+
|
1037
|
+
- **Content-Type**: application/json
|
1038
|
+
- **Accept**: application/json
|
1039
|
+
|
1040
|
+
|
1041
|
+
## k8s_nodepools_put
|
1042
|
+
|
1043
|
+
> <KubernetesNodePoolForPut> k8s_nodepools_put(k8s_cluster_id, nodepool_id, kubernetes_node_pool, opts)
|
1044
|
+
|
1045
|
+
Modify Kubernetes Node Pool
|
1046
|
+
|
1047
|
+
This will modify the Kubernetes Node Pool.
|
1048
|
+
|
1049
|
+
### Examples
|
1050
|
+
|
1051
|
+
```ruby
|
1052
|
+
require 'time'
|
1053
|
+
require 'ionoscloud'
|
1054
|
+
# setup authorization
|
1055
|
+
Ionoscloud.configure do |config|
|
1056
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1057
|
+
config.username = 'YOUR USERNAME'
|
1058
|
+
config.password = 'YOUR PASSWORD'
|
1059
|
+
|
1060
|
+
# Configure API key authorization: Token Authentication
|
1061
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1062
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1063
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1064
|
+
end
|
1065
|
+
|
1066
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
1067
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
1068
|
+
nodepool_id = 'nodepool_id_example' # String | The unique ID of the Kubernetes Node Pool
|
1069
|
+
kubernetes_node_pool = Ionoscloud::KubernetesNodePool.new({properties: Ionoscloud::KubernetesNodePoolProperties.new({name: 'k8s-node-pool', datacenter_id: '1e072e52-2ed3-492f-b6b6-c6b116907521', node_count: 2, cpu_family: 'AMD_OPTERON', cores_count: 4, ram_size: 2048, availability_zone: 'AUTO', storage_type: 'HDD', storage_size: 100})}) # KubernetesNodePool | Details of the Kubernetes Node Pool
|
1070
|
+
opts = {
|
1071
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
1072
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
1073
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
1074
|
+
}
|
1075
|
+
|
1076
|
+
begin
|
1077
|
+
# Modify Kubernetes Node Pool
|
1078
|
+
result = api_instance.k8s_nodepools_put(k8s_cluster_id, nodepool_id, kubernetes_node_pool, opts)
|
1079
|
+
p result
|
1080
|
+
rescue Ionoscloud::ApiError => e
|
1081
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_put: #{e}"
|
1082
|
+
end
|
1083
|
+
```
|
1084
|
+
|
1085
|
+
#### Using the k8s_nodepools_put_with_http_info variant
|
1086
|
+
|
1087
|
+
This returns an Array which contains the response data, status code and headers.
|
1088
|
+
|
1089
|
+
> <Array(<KubernetesNodePoolForPut>, Integer, Hash)> k8s_nodepools_put_with_http_info(k8s_cluster_id, nodepool_id, kubernetes_node_pool, opts)
|
1090
|
+
|
1091
|
+
```ruby
|
1092
|
+
begin
|
1093
|
+
# Modify Kubernetes Node Pool
|
1094
|
+
data, status_code, headers = api_instance.k8s_nodepools_put_with_http_info(k8s_cluster_id, nodepool_id, kubernetes_node_pool, opts)
|
1095
|
+
p status_code # => 2xx
|
1096
|
+
p headers # => { ... }
|
1097
|
+
p data # => <KubernetesNodePoolForPut>
|
1098
|
+
rescue Ionoscloud::ApiError => e
|
1099
|
+
puts "Error when calling KubernetesApi->k8s_nodepools_put_with_http_info: #{e}"
|
1100
|
+
end
|
1101
|
+
```
|
1102
|
+
|
1103
|
+
### Parameters
|
1104
|
+
|
1105
|
+
| Name | Type | Description | Notes |
|
1106
|
+
| ---- | ---- | ----------- | ----- |
|
1107
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
1108
|
+
| **nodepool_id** | **String** | The unique ID of the Kubernetes Node Pool | |
|
1109
|
+
| **kubernetes_node_pool** | [**KubernetesNodePool**](KubernetesNodePool.md) | Details of the Kubernetes Node Pool | |
|
1110
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
1111
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
1112
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
1113
|
+
|
1114
|
+
### Return type
|
1115
|
+
|
1116
|
+
[**KubernetesNodePoolForPut**](KubernetesNodePoolForPut.md)
|
1117
|
+
|
1118
|
+
### Authorization
|
1119
|
+
|
1120
|
+
Basic Authentication, Token Authentication
|
1121
|
+
|
1122
|
+
### HTTP request headers
|
1123
|
+
|
1124
|
+
- **Content-Type**: application/json
|
1125
|
+
- **Accept**: application/json
|
1126
|
+
|
1127
|
+
|
1128
|
+
## k8s_post
|
1129
|
+
|
1130
|
+
> <KubernetesCluster> k8s_post(kubernetes_cluster, opts)
|
1131
|
+
|
1132
|
+
Create Kubernetes Cluster
|
1133
|
+
|
1134
|
+
This will create a new Kubernetes Cluster.
|
1135
|
+
|
1136
|
+
### Examples
|
1137
|
+
|
1138
|
+
```ruby
|
1139
|
+
require 'time'
|
1140
|
+
require 'ionoscloud'
|
1141
|
+
# setup authorization
|
1142
|
+
Ionoscloud.configure do |config|
|
1143
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1144
|
+
config.username = 'YOUR USERNAME'
|
1145
|
+
config.password = 'YOUR PASSWORD'
|
1146
|
+
|
1147
|
+
# Configure API key authorization: Token Authentication
|
1148
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1149
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1150
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1151
|
+
end
|
1152
|
+
|
1153
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
1154
|
+
kubernetes_cluster = Ionoscloud::KubernetesCluster.new({properties: Ionoscloud::KubernetesClusterProperties.new({name: 'k8s'})}) # KubernetesCluster | Properties of the Kubernetes Cluster
|
1155
|
+
opts = {
|
1156
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
1157
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
1158
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
1159
|
+
}
|
1160
|
+
|
1161
|
+
begin
|
1162
|
+
# Create Kubernetes Cluster
|
1163
|
+
result = api_instance.k8s_post(kubernetes_cluster, opts)
|
1164
|
+
p result
|
1165
|
+
rescue Ionoscloud::ApiError => e
|
1166
|
+
puts "Error when calling KubernetesApi->k8s_post: #{e}"
|
1167
|
+
end
|
1168
|
+
```
|
1169
|
+
|
1170
|
+
#### Using the k8s_post_with_http_info variant
|
1171
|
+
|
1172
|
+
This returns an Array which contains the response data, status code and headers.
|
1173
|
+
|
1174
|
+
> <Array(<KubernetesCluster>, Integer, Hash)> k8s_post_with_http_info(kubernetes_cluster, opts)
|
1175
|
+
|
1176
|
+
```ruby
|
1177
|
+
begin
|
1178
|
+
# Create Kubernetes Cluster
|
1179
|
+
data, status_code, headers = api_instance.k8s_post_with_http_info(kubernetes_cluster, opts)
|
1180
|
+
p status_code # => 2xx
|
1181
|
+
p headers # => { ... }
|
1182
|
+
p data # => <KubernetesCluster>
|
1183
|
+
rescue Ionoscloud::ApiError => e
|
1184
|
+
puts "Error when calling KubernetesApi->k8s_post_with_http_info: #{e}"
|
1185
|
+
end
|
1186
|
+
```
|
1187
|
+
|
1188
|
+
### Parameters
|
1189
|
+
|
1190
|
+
| Name | Type | Description | Notes |
|
1191
|
+
| ---- | ---- | ----------- | ----- |
|
1192
|
+
| **kubernetes_cluster** | [**KubernetesCluster**](KubernetesCluster.md) | Properties of the Kubernetes Cluster | |
|
1193
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
1194
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
1195
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
1196
|
+
|
1197
|
+
### Return type
|
1198
|
+
|
1199
|
+
[**KubernetesCluster**](KubernetesCluster.md)
|
1200
|
+
|
1201
|
+
### Authorization
|
1202
|
+
|
1203
|
+
Basic Authentication, Token Authentication
|
1204
|
+
|
1205
|
+
### HTTP request headers
|
1206
|
+
|
1207
|
+
- **Content-Type**: application/json
|
1208
|
+
- **Accept**: application/json
|
1209
|
+
|
1210
|
+
|
1211
|
+
## k8s_put
|
1212
|
+
|
1213
|
+
> <KubernetesCluster> k8s_put(k8s_cluster_id, kubernetes_cluster, opts)
|
1214
|
+
|
1215
|
+
Modify Kubernetes Cluster
|
1216
|
+
|
1217
|
+
This will modify the Kubernetes Cluster.
|
1218
|
+
|
1219
|
+
### Examples
|
1220
|
+
|
1221
|
+
```ruby
|
1222
|
+
require 'time'
|
1223
|
+
require 'ionoscloud'
|
1224
|
+
# setup authorization
|
1225
|
+
Ionoscloud.configure do |config|
|
1226
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1227
|
+
config.username = 'YOUR USERNAME'
|
1228
|
+
config.password = 'YOUR PASSWORD'
|
1229
|
+
|
1230
|
+
# Configure API key authorization: Token Authentication
|
1231
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1232
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1233
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1234
|
+
end
|
1235
|
+
|
1236
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
1237
|
+
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
1238
|
+
kubernetes_cluster = Ionoscloud::KubernetesCluster.new({properties: Ionoscloud::KubernetesClusterProperties.new({name: 'k8s'})}) # KubernetesCluster | Properties of the Kubernetes Cluster
|
1239
|
+
opts = {
|
1240
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
1241
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
1242
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
1243
|
+
}
|
1244
|
+
|
1245
|
+
begin
|
1246
|
+
# Modify Kubernetes Cluster
|
1247
|
+
result = api_instance.k8s_put(k8s_cluster_id, kubernetes_cluster, opts)
|
1248
|
+
p result
|
1249
|
+
rescue Ionoscloud::ApiError => e
|
1250
|
+
puts "Error when calling KubernetesApi->k8s_put: #{e}"
|
1251
|
+
end
|
1252
|
+
```
|
1253
|
+
|
1254
|
+
#### Using the k8s_put_with_http_info variant
|
1255
|
+
|
1256
|
+
This returns an Array which contains the response data, status code and headers.
|
1257
|
+
|
1258
|
+
> <Array(<KubernetesCluster>, Integer, Hash)> k8s_put_with_http_info(k8s_cluster_id, kubernetes_cluster, opts)
|
1259
|
+
|
1260
|
+
```ruby
|
1261
|
+
begin
|
1262
|
+
# Modify Kubernetes Cluster
|
1263
|
+
data, status_code, headers = api_instance.k8s_put_with_http_info(k8s_cluster_id, kubernetes_cluster, opts)
|
1264
|
+
p status_code # => 2xx
|
1265
|
+
p headers # => { ... }
|
1266
|
+
p data # => <KubernetesCluster>
|
1267
|
+
rescue Ionoscloud::ApiError => e
|
1268
|
+
puts "Error when calling KubernetesApi->k8s_put_with_http_info: #{e}"
|
1269
|
+
end
|
1270
|
+
```
|
1271
|
+
|
1272
|
+
### Parameters
|
1273
|
+
|
1274
|
+
| Name | Type | Description | Notes |
|
1275
|
+
| ---- | ---- | ----------- | ----- |
|
1276
|
+
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
1277
|
+
| **kubernetes_cluster** | [**KubernetesCluster**](KubernetesCluster.md) | Properties of the Kubernetes Cluster | |
|
1278
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
1279
|
+
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
1280
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
1281
|
+
|
1282
|
+
### Return type
|
1283
|
+
|
1284
|
+
[**KubernetesCluster**](KubernetesCluster.md)
|
1285
|
+
|
1286
|
+
### Authorization
|
1287
|
+
|
1288
|
+
Basic Authentication, Token Authentication
|
1289
|
+
|
1290
|
+
### HTTP request headers
|
1291
|
+
|
1292
|
+
- **Content-Type**: application/json
|
1293
|
+
- **Accept**: application/json
|
1294
|
+
|
1295
|
+
|
1296
|
+
## k8s_versions_compatibilities_get
|
1297
|
+
|
1298
|
+
> Array<String> k8s_versions_compatibilities_get(cluster_version)
|
1299
|
+
|
1300
|
+
Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.
|
1301
|
+
|
1302
|
+
You can retrieve a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.
|
1303
|
+
|
1304
|
+
### Examples
|
1305
|
+
|
1306
|
+
```ruby
|
1307
|
+
require 'time'
|
1308
|
+
require 'ionoscloud'
|
1309
|
+
# setup authorization
|
1310
|
+
Ionoscloud.configure do |config|
|
1311
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1312
|
+
config.username = 'YOUR USERNAME'
|
1313
|
+
config.password = 'YOUR PASSWORD'
|
1314
|
+
|
1315
|
+
# Configure API key authorization: Token Authentication
|
1316
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1317
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1318
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1319
|
+
end
|
1320
|
+
|
1321
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
1322
|
+
cluster_version = 'cluster_version_example' # String |
|
1323
|
+
|
1324
|
+
begin
|
1325
|
+
# Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.
|
1326
|
+
result = api_instance.k8s_versions_compatibilities_get(cluster_version)
|
1327
|
+
p result
|
1328
|
+
rescue Ionoscloud::ApiError => e
|
1329
|
+
puts "Error when calling KubernetesApi->k8s_versions_compatibilities_get: #{e}"
|
1330
|
+
end
|
1331
|
+
```
|
1332
|
+
|
1333
|
+
#### Using the k8s_versions_compatibilities_get_with_http_info variant
|
1334
|
+
|
1335
|
+
This returns an Array which contains the response data, status code and headers.
|
1336
|
+
|
1337
|
+
> <Array(Array<String>, Integer, Hash)> k8s_versions_compatibilities_get_with_http_info(cluster_version)
|
1338
|
+
|
1339
|
+
```ruby
|
1340
|
+
begin
|
1341
|
+
# Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.
|
1342
|
+
data, status_code, headers = api_instance.k8s_versions_compatibilities_get_with_http_info(cluster_version)
|
1343
|
+
p status_code # => 2xx
|
1344
|
+
p headers # => { ... }
|
1345
|
+
p data # => Array<String>
|
1346
|
+
rescue Ionoscloud::ApiError => e
|
1347
|
+
puts "Error when calling KubernetesApi->k8s_versions_compatibilities_get_with_http_info: #{e}"
|
1348
|
+
end
|
1349
|
+
```
|
1350
|
+
|
1351
|
+
### Parameters
|
1352
|
+
|
1353
|
+
| Name | Type | Description | Notes |
|
1354
|
+
| ---- | ---- | ----------- | ----- |
|
1355
|
+
| **cluster_version** | **String** | | |
|
1356
|
+
|
1357
|
+
### Return type
|
1358
|
+
|
1359
|
+
**Array<String>**
|
1360
|
+
|
1361
|
+
### Authorization
|
1362
|
+
|
1363
|
+
Basic Authentication, Token Authentication
|
1364
|
+
|
1365
|
+
### HTTP request headers
|
1366
|
+
|
1367
|
+
- **Content-Type**: Not defined
|
1368
|
+
- **Accept**: application/json
|
1369
|
+
|
1370
|
+
|
1371
|
+
## k8s_versions_default_get
|
1372
|
+
|
1373
|
+
> String k8s_versions_default_get
|
1374
|
+
|
1375
|
+
Retrieve the current default kubernetes version for clusters and nodepools.
|
1376
|
+
|
1377
|
+
You can retrieve the current default kubernetes version for clusters and nodepools.
|
1378
|
+
|
1379
|
+
### Examples
|
1380
|
+
|
1381
|
+
```ruby
|
1382
|
+
require 'time'
|
1383
|
+
require 'ionoscloud'
|
1384
|
+
# setup authorization
|
1385
|
+
Ionoscloud.configure do |config|
|
1386
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1387
|
+
config.username = 'YOUR USERNAME'
|
1388
|
+
config.password = 'YOUR PASSWORD'
|
1389
|
+
|
1390
|
+
# Configure API key authorization: Token Authentication
|
1391
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1392
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1393
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1394
|
+
end
|
1395
|
+
|
1396
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
1397
|
+
|
1398
|
+
begin
|
1399
|
+
# Retrieve the current default kubernetes version for clusters and nodepools.
|
1400
|
+
result = api_instance.k8s_versions_default_get
|
1401
|
+
p result
|
1402
|
+
rescue Ionoscloud::ApiError => e
|
1403
|
+
puts "Error when calling KubernetesApi->k8s_versions_default_get: #{e}"
|
1404
|
+
end
|
1405
|
+
```
|
1406
|
+
|
1407
|
+
#### Using the k8s_versions_default_get_with_http_info variant
|
1408
|
+
|
1409
|
+
This returns an Array which contains the response data, status code and headers.
|
1410
|
+
|
1411
|
+
> <Array(String, Integer, Hash)> k8s_versions_default_get_with_http_info
|
1412
|
+
|
1413
|
+
```ruby
|
1414
|
+
begin
|
1415
|
+
# Retrieve the current default kubernetes version for clusters and nodepools.
|
1416
|
+
data, status_code, headers = api_instance.k8s_versions_default_get_with_http_info
|
1417
|
+
p status_code # => 2xx
|
1418
|
+
p headers # => { ... }
|
1419
|
+
p data # => String
|
1420
|
+
rescue Ionoscloud::ApiError => e
|
1421
|
+
puts "Error when calling KubernetesApi->k8s_versions_default_get_with_http_info: #{e}"
|
1422
|
+
end
|
1423
|
+
```
|
1424
|
+
|
1425
|
+
### Parameters
|
1426
|
+
|
1427
|
+
This endpoint does not need any parameter.
|
1428
|
+
|
1429
|
+
### Return type
|
1430
|
+
|
1431
|
+
**String**
|
1432
|
+
|
1433
|
+
### Authorization
|
1434
|
+
|
1435
|
+
Basic Authentication, Token Authentication
|
1436
|
+
|
1437
|
+
### HTTP request headers
|
1438
|
+
|
1439
|
+
- **Content-Type**: Not defined
|
1440
|
+
- **Accept**: application/json
|
1441
|
+
|
1442
|
+
|
1443
|
+
## k8s_versions_get
|
1444
|
+
|
1445
|
+
> Array<String> k8s_versions_get
|
1446
|
+
|
1447
|
+
Retrieve available Kubernetes versions
|
1448
|
+
|
1449
|
+
You can retrieve a list of available kubernetes versions
|
1450
|
+
|
1451
|
+
### Examples
|
1452
|
+
|
1453
|
+
```ruby
|
1454
|
+
require 'time'
|
1455
|
+
require 'ionoscloud'
|
1456
|
+
# setup authorization
|
1457
|
+
Ionoscloud.configure do |config|
|
1458
|
+
# Configure HTTP basic authorization: Basic Authentication
|
1459
|
+
config.username = 'YOUR USERNAME'
|
1460
|
+
config.password = 'YOUR PASSWORD'
|
1461
|
+
|
1462
|
+
# Configure API key authorization: Token Authentication
|
1463
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
1464
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1465
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
1466
|
+
end
|
1467
|
+
|
1468
|
+
api_instance = Ionoscloud::KubernetesApi.new
|
1469
|
+
|
1470
|
+
begin
|
1471
|
+
# Retrieve available Kubernetes versions
|
1472
|
+
result = api_instance.k8s_versions_get
|
1473
|
+
p result
|
1474
|
+
rescue Ionoscloud::ApiError => e
|
1475
|
+
puts "Error when calling KubernetesApi->k8s_versions_get: #{e}"
|
1476
|
+
end
|
1477
|
+
```
|
1478
|
+
|
1479
|
+
#### Using the k8s_versions_get_with_http_info variant
|
1480
|
+
|
1481
|
+
This returns an Array which contains the response data, status code and headers.
|
1482
|
+
|
1483
|
+
> <Array(Array<String>, Integer, Hash)> k8s_versions_get_with_http_info
|
1484
|
+
|
1485
|
+
```ruby
|
1486
|
+
begin
|
1487
|
+
# Retrieve available Kubernetes versions
|
1488
|
+
data, status_code, headers = api_instance.k8s_versions_get_with_http_info
|
1489
|
+
p status_code # => 2xx
|
1490
|
+
p headers # => { ... }
|
1491
|
+
p data # => Array<String>
|
1492
|
+
rescue Ionoscloud::ApiError => e
|
1493
|
+
puts "Error when calling KubernetesApi->k8s_versions_get_with_http_info: #{e}"
|
1494
|
+
end
|
1495
|
+
```
|
1496
|
+
|
1497
|
+
### Parameters
|
1498
|
+
|
1499
|
+
This endpoint does not need any parameter.
|
1500
|
+
|
1501
|
+
### Return type
|
1502
|
+
|
1503
|
+
**Array<String>**
|
1504
|
+
|
1505
|
+
### Authorization
|
1506
|
+
|
1507
|
+
Basic Authentication, Token Authentication
|
1508
|
+
|
1509
|
+
### HTTP request headers
|
1510
|
+
|
1511
|
+
- **Content-Type**: Not defined
|
1512
|
+
- **Accept**: application/json
|
1513
|
+
|