ionoscloud 5.0.0 → 5.0.1
Sign up to get free protection for your applications and to get access to all the features.
- 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,22 @@
|
|
1
|
+
# UserMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **etag** | **String** | Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 . Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter. | [optional][readonly] |
|
8
|
+
| **created_date** | **Time** | time of creation of the user | [optional][readonly] |
|
9
|
+
| **last_login** | **Time** | time of last login by the user | [optional][readonly] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ionoscloud'
|
15
|
+
|
16
|
+
instance = Ionoscloud::UserMetadata.new(
|
17
|
+
etag: 45480eb3fbfc31f1d916c1eaa4abdcc3,
|
18
|
+
created_date: 2015-12-04T14:34:09.809Z,
|
19
|
+
last_login: 2015-12-04T14:34:09.809Z
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# UserProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **firstname** | **String** | first name of the user | [optional] |
|
8
|
+
| **lastname** | **String** | last name of the user | [optional] |
|
9
|
+
| **email** | **String** | email address of the user | [optional] |
|
10
|
+
| **administrator** | **Boolean** | indicates if the user has admin rights or not | [optional] |
|
11
|
+
| **force_sec_auth** | **Boolean** | indicates if secure authentication should be forced on the user or not | [optional] |
|
12
|
+
| **sec_auth_active** | **Boolean** | indicates if secure authentication is active for the user or not | [optional] |
|
13
|
+
| **s3_canonical_user_id** | **String** | Canonical (S3) id of the user for a given identity | [optional] |
|
14
|
+
| **password** | **String** | User password | [optional] |
|
15
|
+
| **active** | **Boolean** | indicates if the user is active | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'ionoscloud'
|
21
|
+
|
22
|
+
instance = Ionoscloud::UserProperties.new(
|
23
|
+
firstname: null,
|
24
|
+
lastname: null,
|
25
|
+
email: null,
|
26
|
+
administrator: null,
|
27
|
+
force_sec_auth: null,
|
28
|
+
sec_auth_active: null,
|
29
|
+
s3_canonical_user_id: null,
|
30
|
+
password: null,
|
31
|
+
active: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
data/docs/Users.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# Users
|
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<User>**](User.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::Users.new(
|
18
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
19
|
+
type: "collection",
|
20
|
+
href: <RESOURCE-URI>,
|
21
|
+
items: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UsersEntities
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **owns** | [**ResourcesUsers**](ResourcesUsers.md) | | [optional] |
|
8
|
+
| **groups** | [**GroupUsers**](GroupUsers.md) | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ionoscloud'
|
14
|
+
|
15
|
+
instance = Ionoscloud::UsersEntities.new(
|
16
|
+
owns: null,
|
17
|
+
groups: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/Volume.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# Volume
|
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** | [**VolumeProperties**](VolumeProperties.md) | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ionoscloud'
|
17
|
+
|
18
|
+
instance = Ionoscloud::Volume.new(
|
19
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
20
|
+
type: "volume",
|
21
|
+
href: <RESOURCE-URI>,
|
22
|
+
metadata: null,
|
23
|
+
properties: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/VolumeApi.md
ADDED
@@ -0,0 +1,711 @@
|
|
1
|
+
# VolumeApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v5*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**datacenters_volumes_create_snapshot_post**](VolumeApi.md#datacenters_volumes_create_snapshot_post) | **POST** /datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot | Create Volume Snapshot |
|
8
|
+
| [**datacenters_volumes_delete**](VolumeApi.md#datacenters_volumes_delete) | **DELETE** /datacenters/{datacenterId}/volumes/{volumeId} | Delete a Volume |
|
9
|
+
| [**datacenters_volumes_find_by_id**](VolumeApi.md#datacenters_volumes_find_by_id) | **GET** /datacenters/{datacenterId}/volumes/{volumeId} | Retrieve a Volume |
|
10
|
+
| [**datacenters_volumes_get**](VolumeApi.md#datacenters_volumes_get) | **GET** /datacenters/{datacenterId}/volumes | List Volumes |
|
11
|
+
| [**datacenters_volumes_patch**](VolumeApi.md#datacenters_volumes_patch) | **PATCH** /datacenters/{datacenterId}/volumes/{volumeId} | Partially modify a Volume |
|
12
|
+
| [**datacenters_volumes_post**](VolumeApi.md#datacenters_volumes_post) | **POST** /datacenters/{datacenterId}/volumes | Create a Volume |
|
13
|
+
| [**datacenters_volumes_put**](VolumeApi.md#datacenters_volumes_put) | **PUT** /datacenters/{datacenterId}/volumes/{volumeId} | Modify a Volume |
|
14
|
+
| [**datacenters_volumes_restore_snapshot_post**](VolumeApi.md#datacenters_volumes_restore_snapshot_post) | **POST** /datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshot | Restore Volume Snapshot |
|
15
|
+
|
16
|
+
|
17
|
+
## datacenters_volumes_create_snapshot_post
|
18
|
+
|
19
|
+
> <Snapshot> datacenters_volumes_create_snapshot_post(datacenter_id, volume_id, opts)
|
20
|
+
|
21
|
+
Create Volume Snapshot
|
22
|
+
|
23
|
+
Creates a snapshot of a volume within the datacenter. You can use a snapshot to create a new storage volume or to restore a storage volume.
|
24
|
+
|
25
|
+
### Examples
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'time'
|
29
|
+
require 'ionoscloud'
|
30
|
+
# setup authorization
|
31
|
+
Ionoscloud.configure do |config|
|
32
|
+
# Configure HTTP basic authorization: Basic Authentication
|
33
|
+
config.username = 'YOUR USERNAME'
|
34
|
+
config.password = 'YOUR PASSWORD'
|
35
|
+
|
36
|
+
# Configure API key authorization: Token Authentication
|
37
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
38
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
39
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
40
|
+
end
|
41
|
+
|
42
|
+
api_instance = Ionoscloud::VolumeApi.new
|
43
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
44
|
+
volume_id = 'volume_id_example' # String | The unique ID of the Volume
|
45
|
+
opts = {
|
46
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
47
|
+
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
|
48
|
+
x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
49
|
+
name: 'name_example', # String | The name of the snapshot
|
50
|
+
description: 'description_example', # String | The description of the snapshot
|
51
|
+
sec_auth_protection: true, # Boolean | Flag representing if extra protection is enabled on snapshot e.g. Two Factor protection etc.
|
52
|
+
licence_type: 'UNKNOWN' # String | The OS type of this Snapshot
|
53
|
+
}
|
54
|
+
|
55
|
+
begin
|
56
|
+
# Create Volume Snapshot
|
57
|
+
result = api_instance.datacenters_volumes_create_snapshot_post(datacenter_id, volume_id, opts)
|
58
|
+
p result
|
59
|
+
rescue Ionoscloud::ApiError => e
|
60
|
+
puts "Error when calling VolumeApi->datacenters_volumes_create_snapshot_post: #{e}"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
#### Using the datacenters_volumes_create_snapshot_post_with_http_info variant
|
65
|
+
|
66
|
+
This returns an Array which contains the response data, status code and headers.
|
67
|
+
|
68
|
+
> <Array(<Snapshot>, Integer, Hash)> datacenters_volumes_create_snapshot_post_with_http_info(datacenter_id, volume_id, opts)
|
69
|
+
|
70
|
+
```ruby
|
71
|
+
begin
|
72
|
+
# Create Volume Snapshot
|
73
|
+
data, status_code, headers = api_instance.datacenters_volumes_create_snapshot_post_with_http_info(datacenter_id, volume_id, opts)
|
74
|
+
p status_code # => 2xx
|
75
|
+
p headers # => { ... }
|
76
|
+
p data # => <Snapshot>
|
77
|
+
rescue Ionoscloud::ApiError => e
|
78
|
+
puts "Error when calling VolumeApi->datacenters_volumes_create_snapshot_post_with_http_info: #{e}"
|
79
|
+
end
|
80
|
+
```
|
81
|
+
|
82
|
+
### Parameters
|
83
|
+
|
84
|
+
| Name | Type | Description | Notes |
|
85
|
+
| ---- | ---- | ----------- | ----- |
|
86
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
87
|
+
| **volume_id** | **String** | The unique ID of the Volume | |
|
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
|
+
| **name** | **String** | The name of the snapshot | [optional] |
|
92
|
+
| **description** | **String** | The description of the snapshot | [optional] |
|
93
|
+
| **sec_auth_protection** | **Boolean** | Flag representing if extra protection is enabled on snapshot e.g. Two Factor protection etc. | [optional] |
|
94
|
+
| **licence_type** | **String** | The OS type of this Snapshot | [optional] |
|
95
|
+
|
96
|
+
### Return type
|
97
|
+
|
98
|
+
[**Snapshot**](Snapshot.md)
|
99
|
+
|
100
|
+
### Authorization
|
101
|
+
|
102
|
+
Basic Authentication, Token Authentication
|
103
|
+
|
104
|
+
### HTTP request headers
|
105
|
+
|
106
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
107
|
+
- **Accept**: application/json
|
108
|
+
|
109
|
+
|
110
|
+
## datacenters_volumes_delete
|
111
|
+
|
112
|
+
> Object datacenters_volumes_delete(datacenter_id, volume_id, opts)
|
113
|
+
|
114
|
+
Delete a Volume
|
115
|
+
|
116
|
+
Deletes the specified volume. This will result in the volume being removed from your datacenter. Use this with caution.
|
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::VolumeApi.new
|
136
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
137
|
+
volume_id = 'volume_id_example' # String | The unique ID of the Volume
|
138
|
+
opts = {
|
139
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
140
|
+
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
|
141
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
142
|
+
}
|
143
|
+
|
144
|
+
begin
|
145
|
+
# Delete a Volume
|
146
|
+
result = api_instance.datacenters_volumes_delete(datacenter_id, volume_id, opts)
|
147
|
+
p result
|
148
|
+
rescue Ionoscloud::ApiError => e
|
149
|
+
puts "Error when calling VolumeApi->datacenters_volumes_delete: #{e}"
|
150
|
+
end
|
151
|
+
```
|
152
|
+
|
153
|
+
#### Using the datacenters_volumes_delete_with_http_info variant
|
154
|
+
|
155
|
+
This returns an Array which contains the response data, status code and headers.
|
156
|
+
|
157
|
+
> <Array(Object, Integer, Hash)> datacenters_volumes_delete_with_http_info(datacenter_id, volume_id, opts)
|
158
|
+
|
159
|
+
```ruby
|
160
|
+
begin
|
161
|
+
# Delete a Volume
|
162
|
+
data, status_code, headers = api_instance.datacenters_volumes_delete_with_http_info(datacenter_id, volume_id, opts)
|
163
|
+
p status_code # => 2xx
|
164
|
+
p headers # => { ... }
|
165
|
+
p data # => Object
|
166
|
+
rescue Ionoscloud::ApiError => e
|
167
|
+
puts "Error when calling VolumeApi->datacenters_volumes_delete_with_http_info: #{e}"
|
168
|
+
end
|
169
|
+
```
|
170
|
+
|
171
|
+
### Parameters
|
172
|
+
|
173
|
+
| Name | Type | Description | Notes |
|
174
|
+
| ---- | ---- | ----------- | ----- |
|
175
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
176
|
+
| **volume_id** | **String** | The unique ID of the Volume | |
|
177
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
178
|
+
| **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] |
|
179
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
180
|
+
|
181
|
+
### Return type
|
182
|
+
|
183
|
+
**Object**
|
184
|
+
|
185
|
+
### Authorization
|
186
|
+
|
187
|
+
Basic Authentication, Token Authentication
|
188
|
+
|
189
|
+
### HTTP request headers
|
190
|
+
|
191
|
+
- **Content-Type**: Not defined
|
192
|
+
- **Accept**: application/json
|
193
|
+
|
194
|
+
|
195
|
+
## datacenters_volumes_find_by_id
|
196
|
+
|
197
|
+
> <Volume> datacenters_volumes_find_by_id(datacenter_id, volume_id, opts)
|
198
|
+
|
199
|
+
Retrieve a Volume
|
200
|
+
|
201
|
+
Retrieves the attributes of a given Volume
|
202
|
+
|
203
|
+
### Examples
|
204
|
+
|
205
|
+
```ruby
|
206
|
+
require 'time'
|
207
|
+
require 'ionoscloud'
|
208
|
+
# setup authorization
|
209
|
+
Ionoscloud.configure do |config|
|
210
|
+
# Configure HTTP basic authorization: Basic Authentication
|
211
|
+
config.username = 'YOUR USERNAME'
|
212
|
+
config.password = 'YOUR PASSWORD'
|
213
|
+
|
214
|
+
# Configure API key authorization: Token Authentication
|
215
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
216
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
217
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
218
|
+
end
|
219
|
+
|
220
|
+
api_instance = Ionoscloud::VolumeApi.new
|
221
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
222
|
+
volume_id = 'volume_id_example' # String | The unique ID of the Volume
|
223
|
+
opts = {
|
224
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
225
|
+
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
|
226
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
227
|
+
}
|
228
|
+
|
229
|
+
begin
|
230
|
+
# Retrieve a Volume
|
231
|
+
result = api_instance.datacenters_volumes_find_by_id(datacenter_id, volume_id, opts)
|
232
|
+
p result
|
233
|
+
rescue Ionoscloud::ApiError => e
|
234
|
+
puts "Error when calling VolumeApi->datacenters_volumes_find_by_id: #{e}"
|
235
|
+
end
|
236
|
+
```
|
237
|
+
|
238
|
+
#### Using the datacenters_volumes_find_by_id_with_http_info variant
|
239
|
+
|
240
|
+
This returns an Array which contains the response data, status code and headers.
|
241
|
+
|
242
|
+
> <Array(<Volume>, Integer, Hash)> datacenters_volumes_find_by_id_with_http_info(datacenter_id, volume_id, opts)
|
243
|
+
|
244
|
+
```ruby
|
245
|
+
begin
|
246
|
+
# Retrieve a Volume
|
247
|
+
data, status_code, headers = api_instance.datacenters_volumes_find_by_id_with_http_info(datacenter_id, volume_id, opts)
|
248
|
+
p status_code # => 2xx
|
249
|
+
p headers # => { ... }
|
250
|
+
p data # => <Volume>
|
251
|
+
rescue Ionoscloud::ApiError => e
|
252
|
+
puts "Error when calling VolumeApi->datacenters_volumes_find_by_id_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
|
+
| **volume_id** | **String** | The unique ID of the Volume | |
|
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
|
+
|
266
|
+
### Return type
|
267
|
+
|
268
|
+
[**Volume**](Volume.md)
|
269
|
+
|
270
|
+
### Authorization
|
271
|
+
|
272
|
+
Basic Authentication, Token Authentication
|
273
|
+
|
274
|
+
### HTTP request headers
|
275
|
+
|
276
|
+
- **Content-Type**: Not defined
|
277
|
+
- **Accept**: application/json
|
278
|
+
|
279
|
+
|
280
|
+
## datacenters_volumes_get
|
281
|
+
|
282
|
+
> <Volumes> datacenters_volumes_get(datacenter_id, opts)
|
283
|
+
|
284
|
+
List Volumes
|
285
|
+
|
286
|
+
Retrieves a list of Volumes.
|
287
|
+
|
288
|
+
### Examples
|
289
|
+
|
290
|
+
```ruby
|
291
|
+
require 'time'
|
292
|
+
require 'ionoscloud'
|
293
|
+
# setup authorization
|
294
|
+
Ionoscloud.configure do |config|
|
295
|
+
# Configure HTTP basic authorization: Basic Authentication
|
296
|
+
config.username = 'YOUR USERNAME'
|
297
|
+
config.password = 'YOUR PASSWORD'
|
298
|
+
|
299
|
+
# Configure API key authorization: Token Authentication
|
300
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
301
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
302
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
303
|
+
end
|
304
|
+
|
305
|
+
api_instance = Ionoscloud::VolumeApi.new
|
306
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
307
|
+
opts = {
|
308
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
309
|
+
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
|
310
|
+
x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
311
|
+
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)
|
312
|
+
limit: 56 # Integer | the maximum number of elements to return (use together with <code>offset</code> for pagination)
|
313
|
+
}
|
314
|
+
|
315
|
+
begin
|
316
|
+
# List Volumes
|
317
|
+
result = api_instance.datacenters_volumes_get(datacenter_id, opts)
|
318
|
+
p result
|
319
|
+
rescue Ionoscloud::ApiError => e
|
320
|
+
puts "Error when calling VolumeApi->datacenters_volumes_get: #{e}"
|
321
|
+
end
|
322
|
+
```
|
323
|
+
|
324
|
+
#### Using the datacenters_volumes_get_with_http_info variant
|
325
|
+
|
326
|
+
This returns an Array which contains the response data, status code and headers.
|
327
|
+
|
328
|
+
> <Array(<Volumes>, Integer, Hash)> datacenters_volumes_get_with_http_info(datacenter_id, opts)
|
329
|
+
|
330
|
+
```ruby
|
331
|
+
begin
|
332
|
+
# List Volumes
|
333
|
+
data, status_code, headers = api_instance.datacenters_volumes_get_with_http_info(datacenter_id, opts)
|
334
|
+
p status_code # => 2xx
|
335
|
+
p headers # => { ... }
|
336
|
+
p data # => <Volumes>
|
337
|
+
rescue Ionoscloud::ApiError => e
|
338
|
+
puts "Error when calling VolumeApi->datacenters_volumes_get_with_http_info: #{e}"
|
339
|
+
end
|
340
|
+
```
|
341
|
+
|
342
|
+
### Parameters
|
343
|
+
|
344
|
+
| Name | Type | Description | Notes |
|
345
|
+
| ---- | ---- | ----------- | ----- |
|
346
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
347
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
348
|
+
| **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] |
|
349
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
350
|
+
| **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] |
|
351
|
+
| **limit** | **Integer** | the maximum number of elements to return (use together with <code>offset</code> for pagination) | [optional][default to 1000] |
|
352
|
+
|
353
|
+
### Return type
|
354
|
+
|
355
|
+
[**Volumes**](Volumes.md)
|
356
|
+
|
357
|
+
### Authorization
|
358
|
+
|
359
|
+
Basic Authentication, Token Authentication
|
360
|
+
|
361
|
+
### HTTP request headers
|
362
|
+
|
363
|
+
- **Content-Type**: Not defined
|
364
|
+
- **Accept**: application/json
|
365
|
+
|
366
|
+
|
367
|
+
## datacenters_volumes_patch
|
368
|
+
|
369
|
+
> <Volume> datacenters_volumes_patch(datacenter_id, volume_id, volume, opts)
|
370
|
+
|
371
|
+
Partially modify a Volume
|
372
|
+
|
373
|
+
You can use update attributes of a Volume
|
374
|
+
|
375
|
+
### Examples
|
376
|
+
|
377
|
+
```ruby
|
378
|
+
require 'time'
|
379
|
+
require 'ionoscloud'
|
380
|
+
# setup authorization
|
381
|
+
Ionoscloud.configure do |config|
|
382
|
+
# Configure HTTP basic authorization: Basic Authentication
|
383
|
+
config.username = 'YOUR USERNAME'
|
384
|
+
config.password = 'YOUR PASSWORD'
|
385
|
+
|
386
|
+
# Configure API key authorization: Token Authentication
|
387
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
388
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
389
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
390
|
+
end
|
391
|
+
|
392
|
+
api_instance = Ionoscloud::VolumeApi.new
|
393
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
394
|
+
volume_id = 'volume_id_example' # String | The unique ID of the Volume
|
395
|
+
volume = Ionoscloud::VolumeProperties.new({size: 100.0}) # VolumeProperties | Modified properties of Volume
|
396
|
+
opts = {
|
397
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
398
|
+
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
|
399
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
400
|
+
}
|
401
|
+
|
402
|
+
begin
|
403
|
+
# Partially modify a Volume
|
404
|
+
result = api_instance.datacenters_volumes_patch(datacenter_id, volume_id, volume, opts)
|
405
|
+
p result
|
406
|
+
rescue Ionoscloud::ApiError => e
|
407
|
+
puts "Error when calling VolumeApi->datacenters_volumes_patch: #{e}"
|
408
|
+
end
|
409
|
+
```
|
410
|
+
|
411
|
+
#### Using the datacenters_volumes_patch_with_http_info variant
|
412
|
+
|
413
|
+
This returns an Array which contains the response data, status code and headers.
|
414
|
+
|
415
|
+
> <Array(<Volume>, Integer, Hash)> datacenters_volumes_patch_with_http_info(datacenter_id, volume_id, volume, opts)
|
416
|
+
|
417
|
+
```ruby
|
418
|
+
begin
|
419
|
+
# Partially modify a Volume
|
420
|
+
data, status_code, headers = api_instance.datacenters_volumes_patch_with_http_info(datacenter_id, volume_id, volume, opts)
|
421
|
+
p status_code # => 2xx
|
422
|
+
p headers # => { ... }
|
423
|
+
p data # => <Volume>
|
424
|
+
rescue Ionoscloud::ApiError => e
|
425
|
+
puts "Error when calling VolumeApi->datacenters_volumes_patch_with_http_info: #{e}"
|
426
|
+
end
|
427
|
+
```
|
428
|
+
|
429
|
+
### Parameters
|
430
|
+
|
431
|
+
| Name | Type | Description | Notes |
|
432
|
+
| ---- | ---- | ----------- | ----- |
|
433
|
+
| **datacenter_id** | **String** | The unique ID of the datacenter | |
|
434
|
+
| **volume_id** | **String** | The unique ID of the Volume | |
|
435
|
+
| **volume** | [**VolumeProperties**](VolumeProperties.md) | Modified properties of Volume | |
|
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
|
+
[**Volume**](Volume.md)
|
443
|
+
|
444
|
+
### Authorization
|
445
|
+
|
446
|
+
Basic Authentication, Token Authentication
|
447
|
+
|
448
|
+
### HTTP request headers
|
449
|
+
|
450
|
+
- **Content-Type**: application/json
|
451
|
+
- **Accept**: application/json
|
452
|
+
|
453
|
+
|
454
|
+
## datacenters_volumes_post
|
455
|
+
|
456
|
+
> <Volume> datacenters_volumes_post(datacenter_id, volume, opts)
|
457
|
+
|
458
|
+
Create a Volume
|
459
|
+
|
460
|
+
Creates a volume within the datacenter. This will not attach the volume to a server. Please see the Servers section for details on how to attach storage volumes
|
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::VolumeApi.new
|
480
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
481
|
+
volume = Ionoscloud::Volume.new({properties: Ionoscloud::VolumeProperties.new({size: 100.0})}) # Volume | Volume to be created
|
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
|
+
# Create a Volume
|
490
|
+
result = api_instance.datacenters_volumes_post(datacenter_id, volume, opts)
|
491
|
+
p result
|
492
|
+
rescue Ionoscloud::ApiError => e
|
493
|
+
puts "Error when calling VolumeApi->datacenters_volumes_post: #{e}"
|
494
|
+
end
|
495
|
+
```
|
496
|
+
|
497
|
+
#### Using the datacenters_volumes_post_with_http_info variant
|
498
|
+
|
499
|
+
This returns an Array which contains the response data, status code and headers.
|
500
|
+
|
501
|
+
> <Array(<Volume>, Integer, Hash)> datacenters_volumes_post_with_http_info(datacenter_id, volume, opts)
|
502
|
+
|
503
|
+
```ruby
|
504
|
+
begin
|
505
|
+
# Create a Volume
|
506
|
+
data, status_code, headers = api_instance.datacenters_volumes_post_with_http_info(datacenter_id, volume, opts)
|
507
|
+
p status_code # => 2xx
|
508
|
+
p headers # => { ... }
|
509
|
+
p data # => <Volume>
|
510
|
+
rescue Ionoscloud::ApiError => e
|
511
|
+
puts "Error when calling VolumeApi->datacenters_volumes_post_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
|
+
| **volume** | [**Volume**](Volume.md) | Volume to be created | |
|
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
|
+
[**Volume**](Volume.md)
|
528
|
+
|
529
|
+
### Authorization
|
530
|
+
|
531
|
+
Basic Authentication, Token Authentication
|
532
|
+
|
533
|
+
### HTTP request headers
|
534
|
+
|
535
|
+
- **Content-Type**: application/json
|
536
|
+
- **Accept**: application/json
|
537
|
+
|
538
|
+
|
539
|
+
## datacenters_volumes_put
|
540
|
+
|
541
|
+
> <Volume> datacenters_volumes_put(datacenter_id, volume_id, volume, opts)
|
542
|
+
|
543
|
+
Modify a Volume
|
544
|
+
|
545
|
+
You can use update attributes of a Volume
|
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::VolumeApi.new
|
565
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
566
|
+
volume_id = 'volume_id_example' # String | The unique ID of the Volume
|
567
|
+
volume = Ionoscloud::Volume.new({properties: Ionoscloud::VolumeProperties.new({size: 100.0})}) # Volume | Modified Volume
|
568
|
+
opts = {
|
569
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
570
|
+
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
|
571
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
572
|
+
}
|
573
|
+
|
574
|
+
begin
|
575
|
+
# Modify a Volume
|
576
|
+
result = api_instance.datacenters_volumes_put(datacenter_id, volume_id, volume, opts)
|
577
|
+
p result
|
578
|
+
rescue Ionoscloud::ApiError => e
|
579
|
+
puts "Error when calling VolumeApi->datacenters_volumes_put: #{e}"
|
580
|
+
end
|
581
|
+
```
|
582
|
+
|
583
|
+
#### Using the datacenters_volumes_put_with_http_info variant
|
584
|
+
|
585
|
+
This returns an Array which contains the response data, status code and headers.
|
586
|
+
|
587
|
+
> <Array(<Volume>, Integer, Hash)> datacenters_volumes_put_with_http_info(datacenter_id, volume_id, volume, opts)
|
588
|
+
|
589
|
+
```ruby
|
590
|
+
begin
|
591
|
+
# Modify a Volume
|
592
|
+
data, status_code, headers = api_instance.datacenters_volumes_put_with_http_info(datacenter_id, volume_id, volume, opts)
|
593
|
+
p status_code # => 2xx
|
594
|
+
p headers # => { ... }
|
595
|
+
p data # => <Volume>
|
596
|
+
rescue Ionoscloud::ApiError => e
|
597
|
+
puts "Error when calling VolumeApi->datacenters_volumes_put_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
|
+
| **volume_id** | **String** | The unique ID of the Volume | |
|
607
|
+
| **volume** | [**Volume**](Volume.md) | Modified Volume | |
|
608
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
609
|
+
| **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] |
|
610
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
611
|
+
|
612
|
+
### Return type
|
613
|
+
|
614
|
+
[**Volume**](Volume.md)
|
615
|
+
|
616
|
+
### Authorization
|
617
|
+
|
618
|
+
Basic Authentication, Token Authentication
|
619
|
+
|
620
|
+
### HTTP request headers
|
621
|
+
|
622
|
+
- **Content-Type**: application/json
|
623
|
+
- **Accept**: application/json
|
624
|
+
|
625
|
+
|
626
|
+
## datacenters_volumes_restore_snapshot_post
|
627
|
+
|
628
|
+
> Object datacenters_volumes_restore_snapshot_post(datacenter_id, volume_id, opts)
|
629
|
+
|
630
|
+
Restore Volume Snapshot
|
631
|
+
|
632
|
+
This will restore a snapshot onto a volume. A snapshot is created as just another image that can be used to create subsequent volumes if you want or to restore an existing volume.
|
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::VolumeApi.new
|
652
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the datacenter
|
653
|
+
volume_id = 'volume_id_example' # String | The unique ID of the Volume
|
654
|
+
opts = {
|
655
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
656
|
+
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
|
657
|
+
x_contract_number: 56, # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
658
|
+
snapshot_id: 'snapshot_id_example' # String | This is the ID of the snapshot
|
659
|
+
}
|
660
|
+
|
661
|
+
begin
|
662
|
+
# Restore Volume Snapshot
|
663
|
+
result = api_instance.datacenters_volumes_restore_snapshot_post(datacenter_id, volume_id, opts)
|
664
|
+
p result
|
665
|
+
rescue Ionoscloud::ApiError => e
|
666
|
+
puts "Error when calling VolumeApi->datacenters_volumes_restore_snapshot_post: #{e}"
|
667
|
+
end
|
668
|
+
```
|
669
|
+
|
670
|
+
#### Using the datacenters_volumes_restore_snapshot_post_with_http_info variant
|
671
|
+
|
672
|
+
This returns an Array which contains the response data, status code and headers.
|
673
|
+
|
674
|
+
> <Array(Object, Integer, Hash)> datacenters_volumes_restore_snapshot_post_with_http_info(datacenter_id, volume_id, opts)
|
675
|
+
|
676
|
+
```ruby
|
677
|
+
begin
|
678
|
+
# Restore Volume Snapshot
|
679
|
+
data, status_code, headers = api_instance.datacenters_volumes_restore_snapshot_post_with_http_info(datacenter_id, volume_id, opts)
|
680
|
+
p status_code # => 2xx
|
681
|
+
p headers # => { ... }
|
682
|
+
p data # => Object
|
683
|
+
rescue Ionoscloud::ApiError => e
|
684
|
+
puts "Error when calling VolumeApi->datacenters_volumes_restore_snapshot_post_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
|
+
| **volume_id** | **String** | The unique ID of the Volume | |
|
694
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
695
|
+
| **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] |
|
696
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
697
|
+
| **snapshot_id** | **String** | This is the ID of the snapshot | [optional] |
|
698
|
+
|
699
|
+
### Return type
|
700
|
+
|
701
|
+
**Object**
|
702
|
+
|
703
|
+
### Authorization
|
704
|
+
|
705
|
+
Basic Authentication, Token Authentication
|
706
|
+
|
707
|
+
### HTTP request headers
|
708
|
+
|
709
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
710
|
+
- **Accept**: application/json
|
711
|
+
|