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
data/docs/LanEntities.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# LanEntities
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **nics** | [**LanNics**](LanNics.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'ionoscloud'
|
13
|
+
|
14
|
+
instance = Ionoscloud::LanEntities.new(
|
15
|
+
nics: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/LanNics.md
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# LanNics
|
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<Nic>**](Nic.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
| **offset** | **Float** | the offset (if specified in the request) | [optional] |
|
12
|
+
| **limit** | **Float** | the limit (if specified in the request) | [optional] |
|
13
|
+
| **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ionoscloud'
|
19
|
+
|
20
|
+
instance = Ionoscloud::LanNics.new(
|
21
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
22
|
+
type: "collection",
|
23
|
+
href: <RESOURCE-URI>,
|
24
|
+
items: null,
|
25
|
+
offset: 0,
|
26
|
+
limit: 1000,
|
27
|
+
_links: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
data/docs/LanPost.md
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# LanPost
|
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
|
+
| **entities** | [**LanEntities**](LanEntities.md) | | [optional] |
|
12
|
+
| **properties** | [**LanPropertiesPost**](LanPropertiesPost.md) | | |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'ionoscloud'
|
18
|
+
|
19
|
+
instance = Ionoscloud::LanPost.new(
|
20
|
+
id: 5,
|
21
|
+
type: "lan",
|
22
|
+
href: <RESOURCE-URI>,
|
23
|
+
metadata: null,
|
24
|
+
entities: null,
|
25
|
+
properties: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# LanProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | A name of that resource | [optional] |
|
8
|
+
| **ip_failover** | [**Array<IPFailover>**](IPFailover.md) | IP failover configurations for lan | [optional] |
|
9
|
+
| **pcc** | **String** | Unique identifier of the private cross connect the given LAN is connected to if any | [optional] |
|
10
|
+
| **public** | **Boolean** | Does this LAN faces the public Internet or not | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::LanProperties.new(
|
18
|
+
name: My resource,
|
19
|
+
ip_failover: null,
|
20
|
+
pcc: 3c11273c-b3e1-4ca3-8134-84fd2dd4ebec,
|
21
|
+
public: true
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# LanPropertiesPost
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | A name of that resource | [optional] |
|
8
|
+
| **ip_failover** | [**Array<IPFailover>**](IPFailover.md) | IP failover configurations for lan | [optional] |
|
9
|
+
| **pcc** | **String** | Unique identifier of the private cross connect the given LAN is connected to if any | [optional] |
|
10
|
+
| **public** | **Boolean** | Does this LAN faces the public Internet or not | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::LanPropertiesPost.new(
|
18
|
+
name: My resource,
|
19
|
+
ip_failover: null,
|
20
|
+
pcc: 3c11273c-b3e1-4ca3-8134-84fd2dd4ebec,
|
21
|
+
public: true
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/Lans.md
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# Lans
|
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<Lan>**](Lan.md) | Array of items in lans collection | [optional][readonly] |
|
11
|
+
| **offset** | **Float** | the offset (if specified in the request) | [optional] |
|
12
|
+
| **limit** | **Float** | the limit (if specified in the request) | [optional] |
|
13
|
+
| **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ionoscloud'
|
19
|
+
|
20
|
+
instance = Ionoscloud::Lans.new(
|
21
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
22
|
+
type: "collection",
|
23
|
+
href: <RESOURCE-URI>,
|
24
|
+
items: null,
|
25
|
+
offset: 0,
|
26
|
+
limit: 1000,
|
27
|
+
_links: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,883 @@
|
|
1
|
+
# LoadBalancerApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v5*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**datacenters_loadbalancers_balancednics_delete**](LoadBalancerApi.md#datacenters_loadbalancers_balancednics_delete) | **DELETE** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId} | Detach a nic from loadbalancer |
|
8
|
+
| [**datacenters_loadbalancers_balancednics_find_by_nic_id**](LoadBalancerApi.md#datacenters_loadbalancers_balancednics_find_by_nic_id) | **GET** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId} | Retrieve a nic attached to Load Balancer |
|
9
|
+
| [**datacenters_loadbalancers_balancednics_get**](LoadBalancerApi.md#datacenters_loadbalancers_balancednics_get) | **GET** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics | List Load Balancer Members |
|
10
|
+
| [**datacenters_loadbalancers_balancednics_post**](LoadBalancerApi.md#datacenters_loadbalancers_balancednics_post) | **POST** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics | Attach a nic to Load Balancer |
|
11
|
+
| [**datacenters_loadbalancers_delete**](LoadBalancerApi.md#datacenters_loadbalancers_delete) | **DELETE** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} | Delete a Loadbalancer. |
|
12
|
+
| [**datacenters_loadbalancers_find_by_id**](LoadBalancerApi.md#datacenters_loadbalancers_find_by_id) | **GET** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} | Retrieve a loadbalancer |
|
13
|
+
| [**datacenters_loadbalancers_get**](LoadBalancerApi.md#datacenters_loadbalancers_get) | **GET** /datacenters/{datacenterId}/loadbalancers | List Load Balancers |
|
14
|
+
| [**datacenters_loadbalancers_patch**](LoadBalancerApi.md#datacenters_loadbalancers_patch) | **PATCH** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} | Partially modify a Loadbalancer |
|
15
|
+
| [**datacenters_loadbalancers_post**](LoadBalancerApi.md#datacenters_loadbalancers_post) | **POST** /datacenters/{datacenterId}/loadbalancers | Create a Load Balancer |
|
16
|
+
| [**datacenters_loadbalancers_put**](LoadBalancerApi.md#datacenters_loadbalancers_put) | **PUT** /datacenters/{datacenterId}/loadbalancers/{loadbalancerId} | Modify a Load Balancer |
|
17
|
+
|
18
|
+
|
19
|
+
## datacenters_loadbalancers_balancednics_delete
|
20
|
+
|
21
|
+
> Object datacenters_loadbalancers_balancednics_delete(datacenter_id, loadbalancer_id, nic_id, opts)
|
22
|
+
|
23
|
+
Detach a nic from loadbalancer
|
24
|
+
|
25
|
+
This will remove a nic from Load Balancer
|
26
|
+
|
27
|
+
### Examples
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
require 'time'
|
31
|
+
require 'ionoscloud'
|
32
|
+
# setup authorization
|
33
|
+
Ionoscloud.configure do |config|
|
34
|
+
# Configure HTTP basic authorization: Basic Authentication
|
35
|
+
config.username = 'YOUR USERNAME'
|
36
|
+
config.password = 'YOUR PASSWORD'
|
37
|
+
|
38
|
+
# Configure API key authorization: Token Authentication
|
39
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
40
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
41
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
42
|
+
end
|
43
|
+
|
44
|
+
api_instance = Ionoscloud::LoadBalancerApi.new
|
45
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
46
|
+
loadbalancer_id = 'loadbalancer_id_example' # String | The unique ID of the Load Balancer
|
47
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
48
|
+
opts = {
|
49
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
50
|
+
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
|
51
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
52
|
+
}
|
53
|
+
|
54
|
+
begin
|
55
|
+
# Detach a nic from loadbalancer
|
56
|
+
result = api_instance.datacenters_loadbalancers_balancednics_delete(datacenter_id, loadbalancer_id, nic_id, opts)
|
57
|
+
p result
|
58
|
+
rescue Ionoscloud::ApiError => e
|
59
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_balancednics_delete: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
#### Using the datacenters_loadbalancers_balancednics_delete_with_http_info variant
|
64
|
+
|
65
|
+
This returns an Array which contains the response data, status code and headers.
|
66
|
+
|
67
|
+
> <Array(Object, Integer, Hash)> datacenters_loadbalancers_balancednics_delete_with_http_info(datacenter_id, loadbalancer_id, nic_id, opts)
|
68
|
+
|
69
|
+
```ruby
|
70
|
+
begin
|
71
|
+
# Detach a nic from loadbalancer
|
72
|
+
data, status_code, headers = api_instance.datacenters_loadbalancers_balancednics_delete_with_http_info(datacenter_id, loadbalancer_id, nic_id, opts)
|
73
|
+
p status_code # => 2xx
|
74
|
+
p headers # => { ... }
|
75
|
+
p data # => Object
|
76
|
+
rescue Ionoscloud::ApiError => e
|
77
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_balancednics_delete_with_http_info: #{e}"
|
78
|
+
end
|
79
|
+
```
|
80
|
+
|
81
|
+
### Parameters
|
82
|
+
|
83
|
+
| Name | Type | Description | Notes |
|
84
|
+
| ---- | ---- | ----------- | ----- |
|
85
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
86
|
+
| **loadbalancer_id** | **String** | The unique ID of the Load Balancer | |
|
87
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
88
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
89
|
+
| **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] |
|
90
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
91
|
+
|
92
|
+
### Return type
|
93
|
+
|
94
|
+
**Object**
|
95
|
+
|
96
|
+
### Authorization
|
97
|
+
|
98
|
+
Basic Authentication, Token Authentication
|
99
|
+
|
100
|
+
### HTTP request headers
|
101
|
+
|
102
|
+
- **Content-Type**: Not defined
|
103
|
+
- **Accept**: application/json
|
104
|
+
|
105
|
+
|
106
|
+
## datacenters_loadbalancers_balancednics_find_by_nic_id
|
107
|
+
|
108
|
+
> <Nic> datacenters_loadbalancers_balancednics_find_by_nic_id(datacenter_id, loadbalancer_id, nic_id, opts)
|
109
|
+
|
110
|
+
Retrieve a nic attached to Load Balancer
|
111
|
+
|
112
|
+
This will retrieve the properties of an attached nic.
|
113
|
+
|
114
|
+
### Examples
|
115
|
+
|
116
|
+
```ruby
|
117
|
+
require 'time'
|
118
|
+
require 'ionoscloud'
|
119
|
+
# setup authorization
|
120
|
+
Ionoscloud.configure do |config|
|
121
|
+
# Configure HTTP basic authorization: Basic Authentication
|
122
|
+
config.username = 'YOUR USERNAME'
|
123
|
+
config.password = 'YOUR PASSWORD'
|
124
|
+
|
125
|
+
# Configure API key authorization: Token Authentication
|
126
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
127
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
128
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
129
|
+
end
|
130
|
+
|
131
|
+
api_instance = Ionoscloud::LoadBalancerApi.new
|
132
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
133
|
+
loadbalancer_id = 'loadbalancer_id_example' # String | The unique ID of the Load Balancer
|
134
|
+
nic_id = 'nic_id_example' # String | The unique ID of the NIC
|
135
|
+
opts = {
|
136
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
137
|
+
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
|
138
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
139
|
+
}
|
140
|
+
|
141
|
+
begin
|
142
|
+
# Retrieve a nic attached to Load Balancer
|
143
|
+
result = api_instance.datacenters_loadbalancers_balancednics_find_by_nic_id(datacenter_id, loadbalancer_id, nic_id, opts)
|
144
|
+
p result
|
145
|
+
rescue Ionoscloud::ApiError => e
|
146
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_balancednics_find_by_nic_id: #{e}"
|
147
|
+
end
|
148
|
+
```
|
149
|
+
|
150
|
+
#### Using the datacenters_loadbalancers_balancednics_find_by_nic_id_with_http_info variant
|
151
|
+
|
152
|
+
This returns an Array which contains the response data, status code and headers.
|
153
|
+
|
154
|
+
> <Array(<Nic>, Integer, Hash)> datacenters_loadbalancers_balancednics_find_by_nic_id_with_http_info(datacenter_id, loadbalancer_id, nic_id, opts)
|
155
|
+
|
156
|
+
```ruby
|
157
|
+
begin
|
158
|
+
# Retrieve a nic attached to Load Balancer
|
159
|
+
data, status_code, headers = api_instance.datacenters_loadbalancers_balancednics_find_by_nic_id_with_http_info(datacenter_id, loadbalancer_id, nic_id, opts)
|
160
|
+
p status_code # => 2xx
|
161
|
+
p headers # => { ... }
|
162
|
+
p data # => <Nic>
|
163
|
+
rescue Ionoscloud::ApiError => e
|
164
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_balancednics_find_by_nic_id_with_http_info: #{e}"
|
165
|
+
end
|
166
|
+
```
|
167
|
+
|
168
|
+
### Parameters
|
169
|
+
|
170
|
+
| Name | Type | Description | Notes |
|
171
|
+
| ---- | ---- | ----------- | ----- |
|
172
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
173
|
+
| **loadbalancer_id** | **String** | The unique ID of the Load Balancer | |
|
174
|
+
| **nic_id** | **String** | The unique ID of the NIC | |
|
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
|
+
[**Nic**](Nic.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
|
+
## datacenters_loadbalancers_balancednics_get
|
194
|
+
|
195
|
+
> <BalancedNics> datacenters_loadbalancers_balancednics_get(datacenter_id, loadbalancer_id, opts)
|
196
|
+
|
197
|
+
List Load Balancer Members
|
198
|
+
|
199
|
+
You can retrieve a list of nics attached to a Load Balancer
|
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::LoadBalancerApi.new
|
219
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
220
|
+
loadbalancer_id = 'loadbalancer_id_example' # String | The unique ID of the Load Balancer
|
221
|
+
opts = {
|
222
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
223
|
+
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
|
224
|
+
x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
225
|
+
offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
|
226
|
+
limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
|
227
|
+
}
|
228
|
+
|
229
|
+
begin
|
230
|
+
# List Load Balancer Members
|
231
|
+
result = api_instance.datacenters_loadbalancers_balancednics_get(datacenter_id, loadbalancer_id, opts)
|
232
|
+
p result
|
233
|
+
rescue Ionoscloud::ApiError => e
|
234
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_balancednics_get: #{e}"
|
235
|
+
end
|
236
|
+
```
|
237
|
+
|
238
|
+
#### Using the datacenters_loadbalancers_balancednics_get_with_http_info variant
|
239
|
+
|
240
|
+
This returns an Array which contains the response data, status code and headers.
|
241
|
+
|
242
|
+
> <Array(<BalancedNics>, Integer, Hash)> datacenters_loadbalancers_balancednics_get_with_http_info(datacenter_id, loadbalancer_id, opts)
|
243
|
+
|
244
|
+
```ruby
|
245
|
+
begin
|
246
|
+
# List Load Balancer Members
|
247
|
+
data, status_code, headers = api_instance.datacenters_loadbalancers_balancednics_get_with_http_info(datacenter_id, loadbalancer_id, opts)
|
248
|
+
p status_code # => 2xx
|
249
|
+
p headers # => { ... }
|
250
|
+
p data # => <BalancedNics>
|
251
|
+
rescue Ionoscloud::ApiError => e
|
252
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_balancednics_get_with_http_info: #{e}"
|
253
|
+
end
|
254
|
+
```
|
255
|
+
|
256
|
+
### Parameters
|
257
|
+
|
258
|
+
| Name | Type | Description | Notes |
|
259
|
+
| ---- | ---- | ----------- | ----- |
|
260
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
261
|
+
| **loadbalancer_id** | **String** | The unique ID of the Load Balancer | |
|
262
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
263
|
+
| **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] |
|
264
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
265
|
+
| **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) | [optional][default to 0] |
|
266
|
+
| **limit** | **Integer** | the maximum number of elements to return (use together with <code>offset</code> for pagination) | [optional][default to 1000] |
|
267
|
+
|
268
|
+
### Return type
|
269
|
+
|
270
|
+
[**BalancedNics**](BalancedNics.md)
|
271
|
+
|
272
|
+
### Authorization
|
273
|
+
|
274
|
+
Basic Authentication, Token Authentication
|
275
|
+
|
276
|
+
### HTTP request headers
|
277
|
+
|
278
|
+
- **Content-Type**: Not defined
|
279
|
+
- **Accept**: application/json
|
280
|
+
|
281
|
+
|
282
|
+
## datacenters_loadbalancers_balancednics_post
|
283
|
+
|
284
|
+
> <Nic> datacenters_loadbalancers_balancednics_post(datacenter_id, loadbalancer_id, nic, opts)
|
285
|
+
|
286
|
+
Attach a nic to Load Balancer
|
287
|
+
|
288
|
+
This will attach a pre-existing nic to a Load Balancer.
|
289
|
+
|
290
|
+
### Examples
|
291
|
+
|
292
|
+
```ruby
|
293
|
+
require 'time'
|
294
|
+
require 'ionoscloud'
|
295
|
+
# setup authorization
|
296
|
+
Ionoscloud.configure do |config|
|
297
|
+
# Configure HTTP basic authorization: Basic Authentication
|
298
|
+
config.username = 'YOUR USERNAME'
|
299
|
+
config.password = 'YOUR PASSWORD'
|
300
|
+
|
301
|
+
# Configure API key authorization: Token Authentication
|
302
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
303
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
304
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
305
|
+
end
|
306
|
+
|
307
|
+
api_instance = Ionoscloud::LoadBalancerApi.new
|
308
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
309
|
+
loadbalancer_id = 'loadbalancer_id_example' # String | The unique ID of the Load Balancer
|
310
|
+
nic = Ionoscloud::Nic.new({properties: Ionoscloud::NicProperties.new({lan: 2})}) # Nic | Nic id to be attached
|
311
|
+
opts = {
|
312
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
313
|
+
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
|
314
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
315
|
+
}
|
316
|
+
|
317
|
+
begin
|
318
|
+
# Attach a nic to Load Balancer
|
319
|
+
result = api_instance.datacenters_loadbalancers_balancednics_post(datacenter_id, loadbalancer_id, nic, opts)
|
320
|
+
p result
|
321
|
+
rescue Ionoscloud::ApiError => e
|
322
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_balancednics_post: #{e}"
|
323
|
+
end
|
324
|
+
```
|
325
|
+
|
326
|
+
#### Using the datacenters_loadbalancers_balancednics_post_with_http_info variant
|
327
|
+
|
328
|
+
This returns an Array which contains the response data, status code and headers.
|
329
|
+
|
330
|
+
> <Array(<Nic>, Integer, Hash)> datacenters_loadbalancers_balancednics_post_with_http_info(datacenter_id, loadbalancer_id, nic, opts)
|
331
|
+
|
332
|
+
```ruby
|
333
|
+
begin
|
334
|
+
# Attach a nic to Load Balancer
|
335
|
+
data, status_code, headers = api_instance.datacenters_loadbalancers_balancednics_post_with_http_info(datacenter_id, loadbalancer_id, nic, opts)
|
336
|
+
p status_code # => 2xx
|
337
|
+
p headers # => { ... }
|
338
|
+
p data # => <Nic>
|
339
|
+
rescue Ionoscloud::ApiError => e
|
340
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_balancednics_post_with_http_info: #{e}"
|
341
|
+
end
|
342
|
+
```
|
343
|
+
|
344
|
+
### Parameters
|
345
|
+
|
346
|
+
| Name | Type | Description | Notes |
|
347
|
+
| ---- | ---- | ----------- | ----- |
|
348
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
349
|
+
| **loadbalancer_id** | **String** | The unique ID of the Load Balancer | |
|
350
|
+
| **nic** | [**Nic**](Nic.md) | Nic id to be attached | |
|
351
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
352
|
+
| **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] |
|
353
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
354
|
+
|
355
|
+
### Return type
|
356
|
+
|
357
|
+
[**Nic**](Nic.md)
|
358
|
+
|
359
|
+
### Authorization
|
360
|
+
|
361
|
+
Basic Authentication, Token Authentication
|
362
|
+
|
363
|
+
### HTTP request headers
|
364
|
+
|
365
|
+
- **Content-Type**: application/json
|
366
|
+
- **Accept**: application/json
|
367
|
+
|
368
|
+
|
369
|
+
## datacenters_loadbalancers_delete
|
370
|
+
|
371
|
+
> Object datacenters_loadbalancers_delete(datacenter_id, loadbalancer_id, opts)
|
372
|
+
|
373
|
+
Delete a Loadbalancer.
|
374
|
+
|
375
|
+
Removes the specific Loadbalancer
|
376
|
+
|
377
|
+
### Examples
|
378
|
+
|
379
|
+
```ruby
|
380
|
+
require 'time'
|
381
|
+
require 'ionoscloud'
|
382
|
+
# setup authorization
|
383
|
+
Ionoscloud.configure do |config|
|
384
|
+
# Configure HTTP basic authorization: Basic Authentication
|
385
|
+
config.username = 'YOUR USERNAME'
|
386
|
+
config.password = 'YOUR PASSWORD'
|
387
|
+
|
388
|
+
# Configure API key authorization: Token Authentication
|
389
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
390
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
391
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
392
|
+
end
|
393
|
+
|
394
|
+
api_instance = Ionoscloud::LoadBalancerApi.new
|
395
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
396
|
+
loadbalancer_id = 'loadbalancer_id_example' # String | The unique ID of the Load Balancer
|
397
|
+
opts = {
|
398
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
399
|
+
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
|
400
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
401
|
+
}
|
402
|
+
|
403
|
+
begin
|
404
|
+
# Delete a Loadbalancer.
|
405
|
+
result = api_instance.datacenters_loadbalancers_delete(datacenter_id, loadbalancer_id, opts)
|
406
|
+
p result
|
407
|
+
rescue Ionoscloud::ApiError => e
|
408
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_delete: #{e}"
|
409
|
+
end
|
410
|
+
```
|
411
|
+
|
412
|
+
#### Using the datacenters_loadbalancers_delete_with_http_info variant
|
413
|
+
|
414
|
+
This returns an Array which contains the response data, status code and headers.
|
415
|
+
|
416
|
+
> <Array(Object, Integer, Hash)> datacenters_loadbalancers_delete_with_http_info(datacenter_id, loadbalancer_id, opts)
|
417
|
+
|
418
|
+
```ruby
|
419
|
+
begin
|
420
|
+
# Delete a Loadbalancer.
|
421
|
+
data, status_code, headers = api_instance.datacenters_loadbalancers_delete_with_http_info(datacenter_id, loadbalancer_id, opts)
|
422
|
+
p status_code # => 2xx
|
423
|
+
p headers # => { ... }
|
424
|
+
p data # => Object
|
425
|
+
rescue Ionoscloud::ApiError => e
|
426
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_delete_with_http_info: #{e}"
|
427
|
+
end
|
428
|
+
```
|
429
|
+
|
430
|
+
### Parameters
|
431
|
+
|
432
|
+
| Name | Type | Description | Notes |
|
433
|
+
| ---- | ---- | ----------- | ----- |
|
434
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
435
|
+
| **loadbalancer_id** | **String** | The unique ID of the Load Balancer | |
|
436
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
437
|
+
| **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] |
|
438
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
439
|
+
|
440
|
+
### Return type
|
441
|
+
|
442
|
+
**Object**
|
443
|
+
|
444
|
+
### Authorization
|
445
|
+
|
446
|
+
Basic Authentication, Token Authentication
|
447
|
+
|
448
|
+
### HTTP request headers
|
449
|
+
|
450
|
+
- **Content-Type**: Not defined
|
451
|
+
- **Accept**: application/json
|
452
|
+
|
453
|
+
|
454
|
+
## datacenters_loadbalancers_find_by_id
|
455
|
+
|
456
|
+
> <Loadbalancer> datacenters_loadbalancers_find_by_id(datacenter_id, loadbalancer_id, opts)
|
457
|
+
|
458
|
+
Retrieve a loadbalancer
|
459
|
+
|
460
|
+
Retrieves the attributes of a given Loadbalancer
|
461
|
+
|
462
|
+
### Examples
|
463
|
+
|
464
|
+
```ruby
|
465
|
+
require 'time'
|
466
|
+
require 'ionoscloud'
|
467
|
+
# setup authorization
|
468
|
+
Ionoscloud.configure do |config|
|
469
|
+
# Configure HTTP basic authorization: Basic Authentication
|
470
|
+
config.username = 'YOUR USERNAME'
|
471
|
+
config.password = 'YOUR PASSWORD'
|
472
|
+
|
473
|
+
# Configure API key authorization: Token Authentication
|
474
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
475
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
476
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
477
|
+
end
|
478
|
+
|
479
|
+
api_instance = Ionoscloud::LoadBalancerApi.new
|
480
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
481
|
+
loadbalancer_id = 'loadbalancer_id_example' # String | The unique ID of the Load Balancer
|
482
|
+
opts = {
|
483
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
484
|
+
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
|
485
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
486
|
+
}
|
487
|
+
|
488
|
+
begin
|
489
|
+
# Retrieve a loadbalancer
|
490
|
+
result = api_instance.datacenters_loadbalancers_find_by_id(datacenter_id, loadbalancer_id, opts)
|
491
|
+
p result
|
492
|
+
rescue Ionoscloud::ApiError => e
|
493
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_find_by_id: #{e}"
|
494
|
+
end
|
495
|
+
```
|
496
|
+
|
497
|
+
#### Using the datacenters_loadbalancers_find_by_id_with_http_info variant
|
498
|
+
|
499
|
+
This returns an Array which contains the response data, status code and headers.
|
500
|
+
|
501
|
+
> <Array(<Loadbalancer>, Integer, Hash)> datacenters_loadbalancers_find_by_id_with_http_info(datacenter_id, loadbalancer_id, opts)
|
502
|
+
|
503
|
+
```ruby
|
504
|
+
begin
|
505
|
+
# Retrieve a loadbalancer
|
506
|
+
data, status_code, headers = api_instance.datacenters_loadbalancers_find_by_id_with_http_info(datacenter_id, loadbalancer_id, opts)
|
507
|
+
p status_code # => 2xx
|
508
|
+
p headers # => { ... }
|
509
|
+
p data # => <Loadbalancer>
|
510
|
+
rescue Ionoscloud::ApiError => e
|
511
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_find_by_id_with_http_info: #{e}"
|
512
|
+
end
|
513
|
+
```
|
514
|
+
|
515
|
+
### Parameters
|
516
|
+
|
517
|
+
| Name | Type | Description | Notes |
|
518
|
+
| ---- | ---- | ----------- | ----- |
|
519
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
520
|
+
| **loadbalancer_id** | **String** | The unique ID of the Load Balancer | |
|
521
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
522
|
+
| **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] |
|
523
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
524
|
+
|
525
|
+
### Return type
|
526
|
+
|
527
|
+
[**Loadbalancer**](Loadbalancer.md)
|
528
|
+
|
529
|
+
### Authorization
|
530
|
+
|
531
|
+
Basic Authentication, Token Authentication
|
532
|
+
|
533
|
+
### HTTP request headers
|
534
|
+
|
535
|
+
- **Content-Type**: Not defined
|
536
|
+
- **Accept**: application/json
|
537
|
+
|
538
|
+
|
539
|
+
## datacenters_loadbalancers_get
|
540
|
+
|
541
|
+
> <Loadbalancers> datacenters_loadbalancers_get(datacenter_id, opts)
|
542
|
+
|
543
|
+
List Load Balancers
|
544
|
+
|
545
|
+
Retrieve a list of Load Balancers within the datacenter
|
546
|
+
|
547
|
+
### Examples
|
548
|
+
|
549
|
+
```ruby
|
550
|
+
require 'time'
|
551
|
+
require 'ionoscloud'
|
552
|
+
# setup authorization
|
553
|
+
Ionoscloud.configure do |config|
|
554
|
+
# Configure HTTP basic authorization: Basic Authentication
|
555
|
+
config.username = 'YOUR USERNAME'
|
556
|
+
config.password = 'YOUR PASSWORD'
|
557
|
+
|
558
|
+
# Configure API key authorization: Token Authentication
|
559
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
560
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
561
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
562
|
+
end
|
563
|
+
|
564
|
+
api_instance = Ionoscloud::LoadBalancerApi.new
|
565
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
566
|
+
opts = {
|
567
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
568
|
+
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
|
569
|
+
x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
570
|
+
offset: 56, # Integer | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination)
|
571
|
+
limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
|
572
|
+
}
|
573
|
+
|
574
|
+
begin
|
575
|
+
# List Load Balancers
|
576
|
+
result = api_instance.datacenters_loadbalancers_get(datacenter_id, opts)
|
577
|
+
p result
|
578
|
+
rescue Ionoscloud::ApiError => e
|
579
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_get: #{e}"
|
580
|
+
end
|
581
|
+
```
|
582
|
+
|
583
|
+
#### Using the datacenters_loadbalancers_get_with_http_info variant
|
584
|
+
|
585
|
+
This returns an Array which contains the response data, status code and headers.
|
586
|
+
|
587
|
+
> <Array(<Loadbalancers>, Integer, Hash)> datacenters_loadbalancers_get_with_http_info(datacenter_id, opts)
|
588
|
+
|
589
|
+
```ruby
|
590
|
+
begin
|
591
|
+
# List Load Balancers
|
592
|
+
data, status_code, headers = api_instance.datacenters_loadbalancers_get_with_http_info(datacenter_id, opts)
|
593
|
+
p status_code # => 2xx
|
594
|
+
p headers # => { ... }
|
595
|
+
p data # => <Loadbalancers>
|
596
|
+
rescue Ionoscloud::ApiError => e
|
597
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_get_with_http_info: #{e}"
|
598
|
+
end
|
599
|
+
```
|
600
|
+
|
601
|
+
### Parameters
|
602
|
+
|
603
|
+
| Name | Type | Description | Notes |
|
604
|
+
| ---- | ---- | ----------- | ----- |
|
605
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
606
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
607
|
+
| **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] |
|
608
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
609
|
+
| **offset** | **Integer** | the first element (of the total list of elements) to include in the response (use together with <code>limit</code> for pagination) | [optional][default to 0] |
|
610
|
+
| **limit** | **Integer** | the maximum number of elements to return (use together with <code>offset</code> for pagination) | [optional][default to 1000] |
|
611
|
+
|
612
|
+
### Return type
|
613
|
+
|
614
|
+
[**Loadbalancers**](Loadbalancers.md)
|
615
|
+
|
616
|
+
### Authorization
|
617
|
+
|
618
|
+
Basic Authentication, Token Authentication
|
619
|
+
|
620
|
+
### HTTP request headers
|
621
|
+
|
622
|
+
- **Content-Type**: Not defined
|
623
|
+
- **Accept**: application/json
|
624
|
+
|
625
|
+
|
626
|
+
## datacenters_loadbalancers_patch
|
627
|
+
|
628
|
+
> <Loadbalancer> datacenters_loadbalancers_patch(datacenter_id, loadbalancer_id, loadbalancer, opts)
|
629
|
+
|
630
|
+
Partially modify a Loadbalancer
|
631
|
+
|
632
|
+
You can use update attributes of a resource
|
633
|
+
|
634
|
+
### Examples
|
635
|
+
|
636
|
+
```ruby
|
637
|
+
require 'time'
|
638
|
+
require 'ionoscloud'
|
639
|
+
# setup authorization
|
640
|
+
Ionoscloud.configure do |config|
|
641
|
+
# Configure HTTP basic authorization: Basic Authentication
|
642
|
+
config.username = 'YOUR USERNAME'
|
643
|
+
config.password = 'YOUR PASSWORD'
|
644
|
+
|
645
|
+
# Configure API key authorization: Token Authentication
|
646
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
647
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
648
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
649
|
+
end
|
650
|
+
|
651
|
+
api_instance = Ionoscloud::LoadBalancerApi.new
|
652
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
653
|
+
loadbalancer_id = 'loadbalancer_id_example' # String | The unique ID of the Load Balancer
|
654
|
+
loadbalancer = Ionoscloud::LoadbalancerProperties.new # LoadbalancerProperties | Modified Loadbalancer
|
655
|
+
opts = {
|
656
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
657
|
+
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
|
658
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
659
|
+
}
|
660
|
+
|
661
|
+
begin
|
662
|
+
# Partially modify a Loadbalancer
|
663
|
+
result = api_instance.datacenters_loadbalancers_patch(datacenter_id, loadbalancer_id, loadbalancer, opts)
|
664
|
+
p result
|
665
|
+
rescue Ionoscloud::ApiError => e
|
666
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_patch: #{e}"
|
667
|
+
end
|
668
|
+
```
|
669
|
+
|
670
|
+
#### Using the datacenters_loadbalancers_patch_with_http_info variant
|
671
|
+
|
672
|
+
This returns an Array which contains the response data, status code and headers.
|
673
|
+
|
674
|
+
> <Array(<Loadbalancer>, Integer, Hash)> datacenters_loadbalancers_patch_with_http_info(datacenter_id, loadbalancer_id, loadbalancer, opts)
|
675
|
+
|
676
|
+
```ruby
|
677
|
+
begin
|
678
|
+
# Partially modify a Loadbalancer
|
679
|
+
data, status_code, headers = api_instance.datacenters_loadbalancers_patch_with_http_info(datacenter_id, loadbalancer_id, loadbalancer, opts)
|
680
|
+
p status_code # => 2xx
|
681
|
+
p headers # => { ... }
|
682
|
+
p data # => <Loadbalancer>
|
683
|
+
rescue Ionoscloud::ApiError => e
|
684
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_patch_with_http_info: #{e}"
|
685
|
+
end
|
686
|
+
```
|
687
|
+
|
688
|
+
### Parameters
|
689
|
+
|
690
|
+
| Name | Type | Description | Notes |
|
691
|
+
| ---- | ---- | ----------- | ----- |
|
692
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
693
|
+
| **loadbalancer_id** | **String** | The unique ID of the Load Balancer | |
|
694
|
+
| **loadbalancer** | [**LoadbalancerProperties**](LoadbalancerProperties.md) | Modified Loadbalancer | |
|
695
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
696
|
+
| **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] |
|
697
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
698
|
+
|
699
|
+
### Return type
|
700
|
+
|
701
|
+
[**Loadbalancer**](Loadbalancer.md)
|
702
|
+
|
703
|
+
### Authorization
|
704
|
+
|
705
|
+
Basic Authentication, Token Authentication
|
706
|
+
|
707
|
+
### HTTP request headers
|
708
|
+
|
709
|
+
- **Content-Type**: application/json
|
710
|
+
- **Accept**: application/json
|
711
|
+
|
712
|
+
|
713
|
+
## datacenters_loadbalancers_post
|
714
|
+
|
715
|
+
> <Loadbalancer> datacenters_loadbalancers_post(datacenter_id, loadbalancer, opts)
|
716
|
+
|
717
|
+
Create a Load Balancer
|
718
|
+
|
719
|
+
Creates a Loadbalancer within the datacenter
|
720
|
+
|
721
|
+
### Examples
|
722
|
+
|
723
|
+
```ruby
|
724
|
+
require 'time'
|
725
|
+
require 'ionoscloud'
|
726
|
+
# setup authorization
|
727
|
+
Ionoscloud.configure do |config|
|
728
|
+
# Configure HTTP basic authorization: Basic Authentication
|
729
|
+
config.username = 'YOUR USERNAME'
|
730
|
+
config.password = 'YOUR PASSWORD'
|
731
|
+
|
732
|
+
# Configure API key authorization: Token Authentication
|
733
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
734
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
735
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
736
|
+
end
|
737
|
+
|
738
|
+
api_instance = Ionoscloud::LoadBalancerApi.new
|
739
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
740
|
+
loadbalancer = Ionoscloud::Loadbalancer.new({properties: Ionoscloud::LoadbalancerProperties.new}) # Loadbalancer | Loadbalancer to be created
|
741
|
+
opts = {
|
742
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
743
|
+
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
|
744
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
745
|
+
}
|
746
|
+
|
747
|
+
begin
|
748
|
+
# Create a Load Balancer
|
749
|
+
result = api_instance.datacenters_loadbalancers_post(datacenter_id, loadbalancer, opts)
|
750
|
+
p result
|
751
|
+
rescue Ionoscloud::ApiError => e
|
752
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_post: #{e}"
|
753
|
+
end
|
754
|
+
```
|
755
|
+
|
756
|
+
#### Using the datacenters_loadbalancers_post_with_http_info variant
|
757
|
+
|
758
|
+
This returns an Array which contains the response data, status code and headers.
|
759
|
+
|
760
|
+
> <Array(<Loadbalancer>, Integer, Hash)> datacenters_loadbalancers_post_with_http_info(datacenter_id, loadbalancer, opts)
|
761
|
+
|
762
|
+
```ruby
|
763
|
+
begin
|
764
|
+
# Create a Load Balancer
|
765
|
+
data, status_code, headers = api_instance.datacenters_loadbalancers_post_with_http_info(datacenter_id, loadbalancer, opts)
|
766
|
+
p status_code # => 2xx
|
767
|
+
p headers # => { ... }
|
768
|
+
p data # => <Loadbalancer>
|
769
|
+
rescue Ionoscloud::ApiError => e
|
770
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_post_with_http_info: #{e}"
|
771
|
+
end
|
772
|
+
```
|
773
|
+
|
774
|
+
### Parameters
|
775
|
+
|
776
|
+
| Name | Type | Description | Notes |
|
777
|
+
| ---- | ---- | ----------- | ----- |
|
778
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
779
|
+
| **loadbalancer** | [**Loadbalancer**](Loadbalancer.md) | Loadbalancer to be created | |
|
780
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
781
|
+
| **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] |
|
782
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
783
|
+
|
784
|
+
### Return type
|
785
|
+
|
786
|
+
[**Loadbalancer**](Loadbalancer.md)
|
787
|
+
|
788
|
+
### Authorization
|
789
|
+
|
790
|
+
Basic Authentication, Token Authentication
|
791
|
+
|
792
|
+
### HTTP request headers
|
793
|
+
|
794
|
+
- **Content-Type**: application/json
|
795
|
+
- **Accept**: application/json
|
796
|
+
|
797
|
+
|
798
|
+
## datacenters_loadbalancers_put
|
799
|
+
|
800
|
+
> <Loadbalancer> datacenters_loadbalancers_put(datacenter_id, loadbalancer_id, loadbalancer, opts)
|
801
|
+
|
802
|
+
Modify a Load Balancer
|
803
|
+
|
804
|
+
You can use update attributes of a resource
|
805
|
+
|
806
|
+
### Examples
|
807
|
+
|
808
|
+
```ruby
|
809
|
+
require 'time'
|
810
|
+
require 'ionoscloud'
|
811
|
+
# setup authorization
|
812
|
+
Ionoscloud.configure do |config|
|
813
|
+
# Configure HTTP basic authorization: Basic Authentication
|
814
|
+
config.username = 'YOUR USERNAME'
|
815
|
+
config.password = 'YOUR PASSWORD'
|
816
|
+
|
817
|
+
# Configure API key authorization: Token Authentication
|
818
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
819
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
820
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
821
|
+
end
|
822
|
+
|
823
|
+
api_instance = Ionoscloud::LoadBalancerApi.new
|
824
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
825
|
+
loadbalancer_id = 'loadbalancer_id_example' # String | The unique ID of the Load Balancer
|
826
|
+
loadbalancer = Ionoscloud::Loadbalancer.new({properties: Ionoscloud::LoadbalancerProperties.new}) # Loadbalancer | Modified Loadbalancer
|
827
|
+
opts = {
|
828
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
829
|
+
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
|
830
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
831
|
+
}
|
832
|
+
|
833
|
+
begin
|
834
|
+
# Modify a Load Balancer
|
835
|
+
result = api_instance.datacenters_loadbalancers_put(datacenter_id, loadbalancer_id, loadbalancer, opts)
|
836
|
+
p result
|
837
|
+
rescue Ionoscloud::ApiError => e
|
838
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_put: #{e}"
|
839
|
+
end
|
840
|
+
```
|
841
|
+
|
842
|
+
#### Using the datacenters_loadbalancers_put_with_http_info variant
|
843
|
+
|
844
|
+
This returns an Array which contains the response data, status code and headers.
|
845
|
+
|
846
|
+
> <Array(<Loadbalancer>, Integer, Hash)> datacenters_loadbalancers_put_with_http_info(datacenter_id, loadbalancer_id, loadbalancer, opts)
|
847
|
+
|
848
|
+
```ruby
|
849
|
+
begin
|
850
|
+
# Modify a Load Balancer
|
851
|
+
data, status_code, headers = api_instance.datacenters_loadbalancers_put_with_http_info(datacenter_id, loadbalancer_id, loadbalancer, opts)
|
852
|
+
p status_code # => 2xx
|
853
|
+
p headers # => { ... }
|
854
|
+
p data # => <Loadbalancer>
|
855
|
+
rescue Ionoscloud::ApiError => e
|
856
|
+
puts "Error when calling LoadBalancerApi->datacenters_loadbalancers_put_with_http_info: #{e}"
|
857
|
+
end
|
858
|
+
```
|
859
|
+
|
860
|
+
### Parameters
|
861
|
+
|
862
|
+
| Name | Type | Description | Notes |
|
863
|
+
| ---- | ---- | ----------- | ----- |
|
864
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
865
|
+
| **loadbalancer_id** | **String** | The unique ID of the Load Balancer | |
|
866
|
+
| **loadbalancer** | [**Loadbalancer**](Loadbalancer.md) | Modified Loadbalancer | |
|
867
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
868
|
+
| **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] |
|
869
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
870
|
+
|
871
|
+
### Return type
|
872
|
+
|
873
|
+
[**Loadbalancer**](Loadbalancer.md)
|
874
|
+
|
875
|
+
### Authorization
|
876
|
+
|
877
|
+
Basic Authentication, Token Authentication
|
878
|
+
|
879
|
+
### HTTP request headers
|
880
|
+
|
881
|
+
- **Content-Type**: application/json
|
882
|
+
- **Accept**: application/json
|
883
|
+
|