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,28 @@
|
|
1
|
+
# Loadbalancer
|
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** | [**LoadbalancerProperties**](LoadbalancerProperties.md) | | |
|
12
|
+
| **entities** | [**LoadbalancerEntities**](LoadbalancerEntities.md) | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'ionoscloud'
|
18
|
+
|
19
|
+
instance = Ionoscloud::Loadbalancer.new(
|
20
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
21
|
+
type: "loadbalancer",
|
22
|
+
href: <RESOURCE-URI>,
|
23
|
+
metadata: null,
|
24
|
+
properties: null,
|
25
|
+
entities: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# LoadbalancerEntities
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **balancednics** | [**BalancedNics**](BalancedNics.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'ionoscloud'
|
13
|
+
|
14
|
+
instance = Ionoscloud::LoadbalancerEntities.new(
|
15
|
+
balancednics: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# LoadbalancerProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | A name of that resource | [optional] |
|
8
|
+
| **ip** | **String** | IPv4 address of the loadbalancer. All attached NICs will inherit this IP. Leaving value null will assign IP automatically | [optional] |
|
9
|
+
| **dhcp** | **Boolean** | Indicates if the loadbalancer will reserve an IP using DHCP | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ionoscloud'
|
15
|
+
|
16
|
+
instance = Ionoscloud::LoadbalancerProperties.new(
|
17
|
+
name: My resource,
|
18
|
+
ip: 22.231.113.64,
|
19
|
+
dhcp: true
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# Loadbalancers
|
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<Loadbalancer>**](Loadbalancer.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::Loadbalancers.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/Location.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# Location
|
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** | [**LocationProperties**](LocationProperties.md) | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ionoscloud'
|
17
|
+
|
18
|
+
instance = Ionoscloud::Location.new(
|
19
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
20
|
+
type: "location",
|
21
|
+
href: <RESOURCE-URI>,
|
22
|
+
metadata: null,
|
23
|
+
properties: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/LocationApi.md
ADDED
@@ -0,0 +1,259 @@
|
|
1
|
+
# LocationApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v5*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**locations_find_by_region_id**](LocationApi.md#locations_find_by_region_id) | **GET** /locations/{regionId} | List Locations within a region |
|
8
|
+
| [**locations_find_by_region_id_and_id**](LocationApi.md#locations_find_by_region_id_and_id) | **GET** /locations/{regionId}/{locationId} | Retrieve a Location |
|
9
|
+
| [**locations_get**](LocationApi.md#locations_get) | **GET** /locations | List Locations |
|
10
|
+
|
11
|
+
|
12
|
+
## locations_find_by_region_id
|
13
|
+
|
14
|
+
> <Locations> locations_find_by_region_id(region_id, opts)
|
15
|
+
|
16
|
+
List Locations within a region
|
17
|
+
|
18
|
+
Retrieve a list of Locations within a world's region
|
19
|
+
|
20
|
+
### Examples
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'time'
|
24
|
+
require 'ionoscloud'
|
25
|
+
# setup authorization
|
26
|
+
Ionoscloud.configure do |config|
|
27
|
+
# Configure HTTP basic authorization: Basic Authentication
|
28
|
+
config.username = 'YOUR USERNAME'
|
29
|
+
config.password = 'YOUR PASSWORD'
|
30
|
+
|
31
|
+
# Configure API key authorization: Token Authentication
|
32
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
33
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
34
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
35
|
+
end
|
36
|
+
|
37
|
+
api_instance = Ionoscloud::LocationApi.new
|
38
|
+
region_id = 'region_id_example' # String |
|
39
|
+
opts = {
|
40
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
41
|
+
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
|
42
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
43
|
+
}
|
44
|
+
|
45
|
+
begin
|
46
|
+
# List Locations within a region
|
47
|
+
result = api_instance.locations_find_by_region_id(region_id, opts)
|
48
|
+
p result
|
49
|
+
rescue Ionoscloud::ApiError => e
|
50
|
+
puts "Error when calling LocationApi->locations_find_by_region_id: #{e}"
|
51
|
+
end
|
52
|
+
```
|
53
|
+
|
54
|
+
#### Using the locations_find_by_region_id_with_http_info variant
|
55
|
+
|
56
|
+
This returns an Array which contains the response data, status code and headers.
|
57
|
+
|
58
|
+
> <Array(<Locations>, Integer, Hash)> locations_find_by_region_id_with_http_info(region_id, opts)
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
begin
|
62
|
+
# List Locations within a region
|
63
|
+
data, status_code, headers = api_instance.locations_find_by_region_id_with_http_info(region_id, opts)
|
64
|
+
p status_code # => 2xx
|
65
|
+
p headers # => { ... }
|
66
|
+
p data # => <Locations>
|
67
|
+
rescue Ionoscloud::ApiError => e
|
68
|
+
puts "Error when calling LocationApi->locations_find_by_region_id_with_http_info: #{e}"
|
69
|
+
end
|
70
|
+
```
|
71
|
+
|
72
|
+
### Parameters
|
73
|
+
|
74
|
+
| Name | Type | Description | Notes |
|
75
|
+
| ---- | ---- | ----------- | ----- |
|
76
|
+
| **region_id** | **String** | | |
|
77
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
78
|
+
| **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] |
|
79
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
80
|
+
|
81
|
+
### Return type
|
82
|
+
|
83
|
+
[**Locations**](Locations.md)
|
84
|
+
|
85
|
+
### Authorization
|
86
|
+
|
87
|
+
Basic Authentication, Token Authentication
|
88
|
+
|
89
|
+
### HTTP request headers
|
90
|
+
|
91
|
+
- **Content-Type**: Not defined
|
92
|
+
- **Accept**: application/json
|
93
|
+
|
94
|
+
|
95
|
+
## locations_find_by_region_id_and_id
|
96
|
+
|
97
|
+
> <Location> locations_find_by_region_id_and_id(region_id, location_id, opts)
|
98
|
+
|
99
|
+
Retrieve a Location
|
100
|
+
|
101
|
+
Retrieves the attributes of a given location
|
102
|
+
|
103
|
+
### Examples
|
104
|
+
|
105
|
+
```ruby
|
106
|
+
require 'time'
|
107
|
+
require 'ionoscloud'
|
108
|
+
# setup authorization
|
109
|
+
Ionoscloud.configure do |config|
|
110
|
+
# Configure HTTP basic authorization: Basic Authentication
|
111
|
+
config.username = 'YOUR USERNAME'
|
112
|
+
config.password = 'YOUR PASSWORD'
|
113
|
+
|
114
|
+
# Configure API key authorization: Token Authentication
|
115
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
116
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
117
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
118
|
+
end
|
119
|
+
|
120
|
+
api_instance = Ionoscloud::LocationApi.new
|
121
|
+
region_id = 'region_id_example' # String |
|
122
|
+
location_id = 'location_id_example' # String |
|
123
|
+
opts = {
|
124
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
125
|
+
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
|
126
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
127
|
+
}
|
128
|
+
|
129
|
+
begin
|
130
|
+
# Retrieve a Location
|
131
|
+
result = api_instance.locations_find_by_region_id_and_id(region_id, location_id, opts)
|
132
|
+
p result
|
133
|
+
rescue Ionoscloud::ApiError => e
|
134
|
+
puts "Error when calling LocationApi->locations_find_by_region_id_and_id: #{e}"
|
135
|
+
end
|
136
|
+
```
|
137
|
+
|
138
|
+
#### Using the locations_find_by_region_id_and_id_with_http_info variant
|
139
|
+
|
140
|
+
This returns an Array which contains the response data, status code and headers.
|
141
|
+
|
142
|
+
> <Array(<Location>, Integer, Hash)> locations_find_by_region_id_and_id_with_http_info(region_id, location_id, opts)
|
143
|
+
|
144
|
+
```ruby
|
145
|
+
begin
|
146
|
+
# Retrieve a Location
|
147
|
+
data, status_code, headers = api_instance.locations_find_by_region_id_and_id_with_http_info(region_id, location_id, opts)
|
148
|
+
p status_code # => 2xx
|
149
|
+
p headers # => { ... }
|
150
|
+
p data # => <Location>
|
151
|
+
rescue Ionoscloud::ApiError => e
|
152
|
+
puts "Error when calling LocationApi->locations_find_by_region_id_and_id_with_http_info: #{e}"
|
153
|
+
end
|
154
|
+
```
|
155
|
+
|
156
|
+
### Parameters
|
157
|
+
|
158
|
+
| Name | Type | Description | Notes |
|
159
|
+
| ---- | ---- | ----------- | ----- |
|
160
|
+
| **region_id** | **String** | | |
|
161
|
+
| **location_id** | **String** | | |
|
162
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
163
|
+
| **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] |
|
164
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
165
|
+
|
166
|
+
### Return type
|
167
|
+
|
168
|
+
[**Location**](Location.md)
|
169
|
+
|
170
|
+
### Authorization
|
171
|
+
|
172
|
+
Basic Authentication, Token Authentication
|
173
|
+
|
174
|
+
### HTTP request headers
|
175
|
+
|
176
|
+
- **Content-Type**: Not defined
|
177
|
+
- **Accept**: application/json
|
178
|
+
|
179
|
+
|
180
|
+
## locations_get
|
181
|
+
|
182
|
+
> <Locations> locations_get(opts)
|
183
|
+
|
184
|
+
List Locations
|
185
|
+
|
186
|
+
Retrieve a list of Locations. This list represents where you can provision your virtual data centers
|
187
|
+
|
188
|
+
### Examples
|
189
|
+
|
190
|
+
```ruby
|
191
|
+
require 'time'
|
192
|
+
require 'ionoscloud'
|
193
|
+
# setup authorization
|
194
|
+
Ionoscloud.configure do |config|
|
195
|
+
# Configure HTTP basic authorization: Basic Authentication
|
196
|
+
config.username = 'YOUR USERNAME'
|
197
|
+
config.password = 'YOUR PASSWORD'
|
198
|
+
|
199
|
+
# Configure API key authorization: Token Authentication
|
200
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
201
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
202
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
203
|
+
end
|
204
|
+
|
205
|
+
api_instance = Ionoscloud::LocationApi.new
|
206
|
+
opts = {
|
207
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
208
|
+
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
|
209
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
210
|
+
}
|
211
|
+
|
212
|
+
begin
|
213
|
+
# List Locations
|
214
|
+
result = api_instance.locations_get(opts)
|
215
|
+
p result
|
216
|
+
rescue Ionoscloud::ApiError => e
|
217
|
+
puts "Error when calling LocationApi->locations_get: #{e}"
|
218
|
+
end
|
219
|
+
```
|
220
|
+
|
221
|
+
#### Using the locations_get_with_http_info variant
|
222
|
+
|
223
|
+
This returns an Array which contains the response data, status code and headers.
|
224
|
+
|
225
|
+
> <Array(<Locations>, Integer, Hash)> locations_get_with_http_info(opts)
|
226
|
+
|
227
|
+
```ruby
|
228
|
+
begin
|
229
|
+
# List Locations
|
230
|
+
data, status_code, headers = api_instance.locations_get_with_http_info(opts)
|
231
|
+
p status_code # => 2xx
|
232
|
+
p headers # => { ... }
|
233
|
+
p data # => <Locations>
|
234
|
+
rescue Ionoscloud::ApiError => e
|
235
|
+
puts "Error when calling LocationApi->locations_get_with_http_info: #{e}"
|
236
|
+
end
|
237
|
+
```
|
238
|
+
|
239
|
+
### Parameters
|
240
|
+
|
241
|
+
| Name | Type | Description | Notes |
|
242
|
+
| ---- | ---- | ----------- | ----- |
|
243
|
+
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
244
|
+
| **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] |
|
245
|
+
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
246
|
+
|
247
|
+
### Return type
|
248
|
+
|
249
|
+
[**Locations**](Locations.md)
|
250
|
+
|
251
|
+
### Authorization
|
252
|
+
|
253
|
+
Basic Authentication, Token Authentication
|
254
|
+
|
255
|
+
### HTTP request headers
|
256
|
+
|
257
|
+
- **Content-Type**: Not defined
|
258
|
+
- **Accept**: application/json
|
259
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# LocationProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | A name of that resource | [optional] |
|
8
|
+
| **features** | **Array<String>** | List of features supported by the location | [optional][readonly] |
|
9
|
+
| **image_aliases** | **Array<String>** | List of image aliases available for the location | [optional][readonly] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ionoscloud'
|
15
|
+
|
16
|
+
instance = Ionoscloud::LocationProperties.new(
|
17
|
+
name: My resource,
|
18
|
+
features: [SSD],
|
19
|
+
image_aliases: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Locations.md
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# Locations
|
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<Location>**](Location.md) | Array of items in that collection | [optional][readonly] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ionoscloud'
|
16
|
+
|
17
|
+
instance = Ionoscloud::Locations.new(
|
18
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
19
|
+
type: "collection",
|
20
|
+
href: <RESOURCE-URI>,
|
21
|
+
items: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/Nic.md
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# Nic
|
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** | [**NicProperties**](NicProperties.md) | | |
|
12
|
+
| **entities** | [**NicEntities**](NicEntities.md) | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'ionoscloud'
|
18
|
+
|
19
|
+
instance = Ionoscloud::Nic.new(
|
20
|
+
id: 15f67991-0f51-4efc-a8ad-ef1fb31a480c,
|
21
|
+
type: "nic",
|
22
|
+
href: <RESOURCE-URI>,
|
23
|
+
metadata: null,
|
24
|
+
properties: null,
|
25
|
+
entities: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|