ionoscloud 6.0.0.beta.3 → 6.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +70 -0
- data/LICENSE +190 -0
- data/README.md +13 -2
- data/docs/README.md +66 -2
- data/docs/{BackupUnitsApi.md → api/BackupUnitsApi.md} +101 -101
- data/docs/{ContractResourcesApi.md → api/ContractResourcesApi.md} +12 -12
- data/docs/api/DataCentersApi.md +516 -0
- data/docs/api/DefaultApi.md +78 -0
- data/docs/{FirewallRulesApi.md → api/FirewallRulesApi.md} +125 -125
- data/docs/{FlowLogsApi.md → api/FlowLogsApi.md} +109 -109
- data/docs/api/IPBlocksApi.md +516 -0
- data/docs/api/ImagesApi.md +428 -0
- data/docs/{KubernetesApi.md → api/KubernetesApi.md} +242 -242
- data/docs/api/LANsApi.md +794 -0
- data/docs/api/LabelsApi.md +2338 -0
- data/docs/{LoadBalancersApi.md → api/LoadBalancersApi.md} +166 -174
- data/docs/api/LocationsApi.md +259 -0
- data/docs/{NATGatewaysApi.md → api/NATGatewaysApi.md} +299 -303
- data/docs/{NetworkInterfacesApi.md → api/NetworkInterfacesApi.md} +113 -113
- data/docs/{NetworkLoadBalancersApi.md → api/NetworkLoadBalancersApi.md} +315 -319
- data/docs/api/PrivateCrossConnectsApi.md +426 -0
- data/docs/api/RequestsApi.md +283 -0
- data/docs/api/ServersApi.md +1918 -0
- data/docs/api/SnapshotsApi.md +428 -0
- data/docs/{TemplatesApi.md → api/TemplatesApi.md} +18 -18
- data/docs/api/UserManagementApi.md +2039 -0
- data/docs/api/UserS3KeysApi.md +516 -0
- data/docs/api/VolumesApi.md +709 -0
- data/docs/{AttachedVolumes.md → models/AttachedVolumes.md} +6 -6
- data/docs/{BackupUnit.md → models/BackupUnit.md} +3 -3
- data/docs/{BackupUnitProperties.md → models/BackupUnitProperties.md} +2 -2
- data/docs/{BackupUnitSSO.md → models/BackupUnitSSO.md} +0 -0
- data/docs/{BackupUnits.md → models/BackupUnits.md} +4 -4
- data/docs/{BalancedNics.md → models/BalancedNics.md} +6 -6
- data/docs/{Cdroms.md → models/Cdroms.md} +6 -6
- data/docs/{ConnectableDatacenter.md → models/ConnectableDatacenter.md} +0 -0
- data/docs/{Contract.md → models/Contract.md} +1 -1
- data/docs/{ContractProperties.md → models/ContractProperties.md} +4 -4
- data/docs/{Contracts.md → models/Contracts.md} +4 -4
- data/docs/{CpuArchitectureProperties.md → models/CpuArchitectureProperties.md} +1 -1
- data/docs/{DataCenterEntities.md → models/DataCenterEntities.md} +0 -0
- data/docs/{Datacenter.md → models/Datacenter.md} +3 -3
- data/docs/{DatacenterElementMetadata.md → models/DatacenterElementMetadata.md} +6 -6
- data/docs/{DatacenterProperties.md → models/DatacenterProperties.md} +6 -6
- data/docs/{Datacenters.md → models/Datacenters.md} +6 -6
- data/docs/{Error.md → models/Error.md} +1 -1
- data/docs/{ErrorMessage.md → models/ErrorMessage.md} +3 -3
- data/docs/{FirewallRule.md → models/FirewallRule.md} +3 -3
- data/docs/{FirewallRules.md → models/FirewallRules.md} +6 -6
- data/docs/{FirewallruleProperties.md → models/FirewallruleProperties.md} +10 -10
- data/docs/{FlowLog.md → models/FlowLog.md} +3 -3
- data/docs/{FlowLogProperties.md → models/FlowLogProperties.md} +1 -1
- data/docs/{FlowLogPut.md → models/FlowLogPut.md} +3 -3
- data/docs/{FlowLogs.md → models/FlowLogs.md} +6 -6
- data/docs/{Group.md → models/Group.md} +3 -3
- data/docs/{GroupEntities.md → models/GroupEntities.md} +0 -0
- data/docs/{GroupMembers.md → models/GroupMembers.md} +4 -4
- data/docs/{GroupProperties.md → models/GroupProperties.md} +11 -11
- data/docs/{GroupShare.md → models/GroupShare.md} +2 -2
- data/docs/{GroupShareProperties.md → models/GroupShareProperties.md} +0 -0
- data/docs/{GroupShares.md → models/GroupShares.md} +3 -3
- data/docs/{GroupUsers.md → models/GroupUsers.md} +4 -4
- data/docs/{Groups.md → models/Groups.md} +4 -4
- data/docs/{IPFailover.md → models/IPFailover.md} +0 -0
- data/docs/{Image.md → models/Image.md} +3 -3
- data/docs/models/ImageProperties.md +54 -0
- data/docs/{Images.md → models/Images.md} +4 -4
- data/docs/{Info.md → models/Info.md} +0 -0
- data/docs/{IpBlock.md → models/IpBlock.md} +3 -3
- data/docs/{IpBlockProperties.md → models/IpBlockProperties.md} +5 -5
- data/docs/models/IpBlocks.md +30 -0
- data/docs/{IpConsumer.md → models/IpConsumer.md} +0 -0
- data/docs/{KubernetesAutoScaling.md → models/KubernetesAutoScaling.md} +0 -0
- data/docs/{KubernetesCluster.md → models/KubernetesCluster.md} +2 -2
- data/docs/{KubernetesClusterEntities.md → models/KubernetesClusterEntities.md} +0 -0
- data/docs/{KubernetesClusterForPost.md → models/KubernetesClusterForPost.md} +2 -2
- data/docs/{KubernetesClusterForPut.md → models/KubernetesClusterForPut.md} +2 -2
- data/docs/{KubernetesClusterProperties.md → models/KubernetesClusterProperties.md} +6 -4
- data/docs/models/KubernetesClusterPropertiesForPost.md +28 -0
- data/docs/models/KubernetesClusterPropertiesForPut.md +26 -0
- data/docs/{KubernetesClusters.md → models/KubernetesClusters.md} +4 -4
- data/docs/{KubernetesMaintenanceWindow.md → models/KubernetesMaintenanceWindow.md} +0 -0
- data/docs/{KubernetesNode.md → models/KubernetesNode.md} +2 -2
- data/docs/{KubernetesNodeMetadata.md → models/KubernetesNodeMetadata.md} +4 -4
- data/docs/{KubernetesNodePool.md → models/KubernetesNodePool.md} +2 -2
- data/docs/{KubernetesNodePoolForPost.md → models/KubernetesNodePoolForPost.md} +2 -2
- data/docs/{KubernetesNodePoolForPut.md → models/KubernetesNodePoolForPut.md} +2 -2
- data/docs/{KubernetesNodePoolLan.md → models/KubernetesNodePoolLan.md} +2 -2
- data/docs/{KubernetesNodePoolLanRoutes.md → models/KubernetesNodePoolLanRoutes.md} +0 -0
- data/docs/{KubernetesNodePoolProperties.md → models/KubernetesNodePoolProperties.md} +16 -14
- data/docs/models/KubernetesNodePoolPropertiesForPost.md +50 -0
- data/docs/{KubernetesNodePoolPropertiesForPut.md → models/KubernetesNodePoolPropertiesForPut.md} +6 -6
- data/docs/{KubernetesNodePools.md → models/KubernetesNodePools.md} +4 -4
- data/docs/{KubernetesNodeProperties.md → models/KubernetesNodeProperties.md} +2 -2
- data/docs/{KubernetesNodes.md → models/KubernetesNodes.md} +4 -4
- data/docs/{Label.md → models/Label.md} +2 -2
- data/docs/{LabelProperties.md → models/LabelProperties.md} +3 -3
- data/docs/{LabelResource.md → models/LabelResource.md} +2 -2
- data/docs/{LabelResourceProperties.md → models/LabelResourceProperties.md} +2 -2
- data/docs/{LabelResources.md → models/LabelResources.md} +6 -6
- data/docs/{Labels.md → models/Labels.md} +4 -4
- data/docs/{Lan.md → models/Lan.md} +3 -3
- data/docs/{LanEntities.md → models/LanEntities.md} +0 -0
- data/docs/{LanNics.md → models/LanNics.md} +6 -6
- data/docs/{LanPost.md → models/LanPost.md} +3 -3
- data/docs/{LanProperties.md → models/LanProperties.md} +3 -3
- data/docs/{LanPropertiesPost.md → models/LanPropertiesPost.md} +3 -3
- data/docs/{Lans.md → models/Lans.md} +6 -6
- data/docs/{Loadbalancer.md → models/Loadbalancer.md} +3 -3
- data/docs/{LoadbalancerEntities.md → models/LoadbalancerEntities.md} +0 -0
- data/docs/{LoadbalancerProperties.md → models/LoadbalancerProperties.md} +3 -3
- data/docs/{Loadbalancers.md → models/Loadbalancers.md} +6 -6
- data/docs/{Location.md → models/Location.md} +3 -3
- data/docs/{LocationProperties.md → models/LocationProperties.md} +1 -1
- data/docs/{Locations.md → models/Locations.md} +4 -4
- data/docs/{NatGateway.md → models/NatGateway.md} +3 -3
- data/docs/{NatGatewayEntities.md → models/NatGatewayEntities.md} +0 -0
- data/docs/{NatGatewayLanProperties.md → models/NatGatewayLanProperties.md} +2 -2
- data/docs/{NatGatewayProperties.md → models/NatGatewayProperties.md} +3 -3
- data/docs/{NatGatewayPut.md → models/NatGatewayPut.md} +3 -3
- data/docs/{NatGatewayRule.md → models/NatGatewayRule.md} +3 -3
- data/docs/{NatGatewayRuleProperties.md → models/NatGatewayRuleProperties.md} +7 -7
- data/docs/{NatGatewayRuleProtocol.md → models/NatGatewayRuleProtocol.md} +0 -0
- data/docs/{NatGatewayRulePut.md → models/NatGatewayRulePut.md} +3 -3
- data/docs/{NatGatewayRuleType.md → models/NatGatewayRuleType.md} +0 -0
- data/docs/{NatGatewayRules.md → models/NatGatewayRules.md} +4 -4
- data/docs/{NatGateways.md → models/NatGateways.md} +6 -6
- data/docs/{NetworkLoadBalancer.md → models/NetworkLoadBalancer.md} +3 -3
- data/docs/{NetworkLoadBalancerEntities.md → models/NetworkLoadBalancerEntities.md} +0 -0
- data/docs/{NetworkLoadBalancerForwardingRule.md → models/NetworkLoadBalancerForwardingRule.md} +3 -3
- data/docs/models/NetworkLoadBalancerForwardingRuleHealthCheck.md +24 -0
- data/docs/{NetworkLoadBalancerForwardingRuleProperties.md → models/NetworkLoadBalancerForwardingRuleProperties.md} +7 -7
- data/docs/{NetworkLoadBalancerForwardingRulePut.md → models/NetworkLoadBalancerForwardingRulePut.md} +3 -3
- data/docs/models/NetworkLoadBalancerForwardingRuleTarget.md +24 -0
- data/docs/models/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md +22 -0
- data/docs/{NetworkLoadBalancerForwardingRules.md → models/NetworkLoadBalancerForwardingRules.md} +6 -6
- data/docs/models/NetworkLoadBalancerProperties.md +26 -0
- data/docs/{NetworkLoadBalancerPut.md → models/NetworkLoadBalancerPut.md} +3 -3
- data/docs/{NetworkLoadBalancers.md → models/NetworkLoadBalancers.md} +6 -6
- data/docs/{Nic.md → models/Nic.md} +3 -3
- data/docs/{NicEntities.md → models/NicEntities.md} +0 -0
- data/docs/models/NicProperties.md +34 -0
- data/docs/{NicPut.md → models/NicPut.md} +3 -3
- data/docs/{Nics.md → models/Nics.md} +6 -6
- data/docs/{NoStateMetaData.md → models/NoStateMetaData.md} +5 -5
- data/docs/{PaginationLinks.md → models/PaginationLinks.md} +3 -3
- data/docs/{Peer.md → models/Peer.md} +0 -0
- data/docs/{PrivateCrossConnect.md → models/PrivateCrossConnect.md} +3 -3
- data/docs/{PrivateCrossConnectProperties.md → models/PrivateCrossConnectProperties.md} +4 -4
- data/docs/{PrivateCrossConnects.md → models/PrivateCrossConnects.md} +4 -4
- data/docs/{RemoteConsoleUrl.md → models/RemoteConsoleUrl.md} +0 -0
- data/docs/{Request.md → models/Request.md} +3 -3
- data/docs/{RequestMetadata.md → models/RequestMetadata.md} +2 -2
- data/docs/{RequestProperties.md → models/RequestProperties.md} +0 -0
- data/docs/{RequestStatus.md → models/RequestStatus.md} +3 -3
- data/docs/{RequestStatusMetadata.md → models/RequestStatusMetadata.md} +1 -1
- data/docs/{RequestTarget.md → models/RequestTarget.md} +0 -0
- data/docs/{Requests.md → models/Requests.md} +6 -6
- data/docs/{Resource.md → models/Resource.md} +3 -3
- data/docs/{ResourceEntities.md → models/ResourceEntities.md} +0 -0
- data/docs/{ResourceGroups.md → models/ResourceGroups.md} +4 -4
- data/docs/models/ResourceLimits.md +60 -0
- data/docs/{ResourceProperties.md → models/ResourceProperties.md} +2 -2
- data/docs/{ResourceReference.md → models/ResourceReference.md} +3 -3
- data/docs/{Resources.md → models/Resources.md} +4 -4
- data/docs/{ResourcesUsers.md → models/ResourcesUsers.md} +4 -4
- data/docs/models/S3Bucket.md +18 -0
- data/docs/{S3Key.md → models/S3Key.md} +3 -3
- data/docs/{S3KeyMetadata.md → models/S3KeyMetadata.md} +2 -2
- data/docs/{S3KeyProperties.md → models/S3KeyProperties.md} +2 -2
- data/docs/{S3Keys.md → models/S3Keys.md} +4 -4
- data/docs/{S3ObjectStorageSSO.md → models/S3ObjectStorageSSO.md} +0 -0
- data/docs/{Server.md → models/Server.md} +3 -3
- data/docs/{ServerEntities.md → models/ServerEntities.md} +0 -0
- data/docs/{ServerProperties.md → models/ServerProperties.md} +7 -7
- data/docs/{Servers.md → models/Servers.md} +6 -6
- data/docs/{Snapshot.md → models/Snapshot.md} +3 -3
- data/docs/models/SnapshotProperties.md +48 -0
- data/docs/{Snapshots.md → models/Snapshots.md} +4 -4
- data/docs/{TargetPortRange.md → models/TargetPortRange.md} +2 -2
- data/docs/{Template.md → models/Template.md} +3 -3
- data/docs/{TemplateProperties.md → models/TemplateProperties.md} +4 -4
- data/docs/{Templates.md → models/Templates.md} +4 -4
- data/docs/{Token.md → models/Token.md} +1 -1
- data/docs/{Type.md → models/Type.md} +0 -0
- data/docs/{User.md → models/User.md} +3 -3
- data/docs/{UserMetadata.md → models/UserMetadata.md} +3 -3
- data/docs/{UserPost.md → models/UserPost.md} +0 -0
- data/docs/models/UserProperties.md +32 -0
- data/docs/models/UserPropertiesPost.md +32 -0
- data/docs/models/UserPropertiesPut.md +32 -0
- data/docs/{UserPut.md → models/UserPut.md} +1 -1
- data/docs/models/Users.md +30 -0
- data/docs/{UsersEntities.md → models/UsersEntities.md} +0 -0
- data/docs/{Volume.md → models/Volume.md} +3 -3
- data/docs/{VolumeProperties.md → models/VolumeProperties.md} +23 -19
- data/docs/{Volumes.md → models/Volumes.md} +6 -6
- data/docs/summary.md +192 -382
- data/git_push.sh +0 -3
- data/ionoscloud.gemspec +4 -4
- data/lib/ionoscloud/api/_api.rb +9 -9
- data/lib/ionoscloud/api/backup_units_api.rb +94 -94
- data/lib/ionoscloud/api/contract_resources_api.rb +13 -13
- data/lib/ionoscloud/api/data_centers_api.rb +81 -81
- data/lib/ionoscloud/api/firewall_rules_api.rb +117 -117
- data/lib/ionoscloud/api/flow_logs_api.rb +103 -103
- data/lib/ionoscloud/api/images_api.rb +65 -65
- data/lib/ionoscloud/api/ip_blocks_api.rb +95 -77
- data/lib/ionoscloud/api/kubernetes_api.rb +218 -218
- data/lib/ionoscloud/api/labels_api.rb +395 -431
- data/lib/ionoscloud/api/lans_api.rb +216 -216
- data/lib/ionoscloud/api/load_balancers_api.rb +153 -189
- data/lib/ionoscloud/api/locations_api.rb +39 -39
- data/lib/ionoscloud/api/nat_gateways_api.rb +273 -291
- data/lib/ionoscloud/api/network_interfaces_api.rb +105 -105
- data/lib/ionoscloud/api/network_load_balancers_api.rb +287 -305
- data/lib/ionoscloud/api/private_cross_connects_api.rb +63 -81
- data/lib/ionoscloud/api/requests_api.rb +63 -63
- data/lib/ionoscloud/api/servers_api.rb +339 -339
- data/lib/ionoscloud/api/snapshots_api.rb +63 -63
- data/lib/ionoscloud/api/templates_api.rb +17 -17
- data/lib/ionoscloud/api/user_management_api.rb +325 -305
- data/lib/ionoscloud/api/user_s3_keys_api.rb +81 -81
- data/lib/ionoscloud/api/volumes_api.rb +132 -132
- data/lib/ionoscloud/api_client.rb +8 -7
- data/lib/ionoscloud/api_error.rb +3 -3
- data/lib/ionoscloud/configuration.rb +3 -3
- data/lib/ionoscloud/models/attached_volumes.rb +76 -20
- data/lib/ionoscloud/models/backup_unit.rb +53 -11
- data/lib/ionoscloud/models/backup_unit_properties.rb +34 -8
- data/lib/ionoscloud/models/backup_unit_sso.rb +14 -4
- data/lib/ionoscloud/models/backup_units.rb +47 -15
- data/lib/ionoscloud/models/balanced_nics.rb +76 -20
- data/lib/ionoscloud/models/cdroms.rb +76 -20
- data/lib/ionoscloud/models/connectable_datacenter.rb +32 -6
- data/lib/ionoscloud/models/contract.rb +24 -6
- data/lib/ionoscloud/models/contract_properties.rb +54 -12
- data/lib/ionoscloud/models/contracts.rb +47 -15
- data/lib/ionoscloud/models/cpu_architecture_properties.rb +42 -8
- data/lib/ionoscloud/models/data_center_entities.rb +59 -9
- data/lib/ionoscloud/models/datacenter.rb +62 -12
- data/lib/ionoscloud/models/datacenter_element_metadata.rb +83 -17
- data/lib/ionoscloud/models/datacenter_properties.rb +78 -24
- data/lib/ionoscloud/models/datacenters.rb +76 -20
- data/lib/ionoscloud/models/error.rb +26 -10
- data/lib/ionoscloud/models/error_message.rb +25 -7
- data/lib/ionoscloud/models/firewall_rule.rb +53 -11
- data/lib/ionoscloud/models/firewall_rules.rb +76 -20
- data/lib/ionoscloud/models/firewallrule_properties.rb +110 -23
- data/lib/ionoscloud/models/flow_log.rb +53 -11
- data/lib/ionoscloud/models/flow_log_properties.rb +42 -8
- data/lib/ionoscloud/models/flow_log_put.rb +44 -10
- data/lib/ionoscloud/models/flow_logs.rb +76 -20
- data/lib/ionoscloud/models/group.rb +53 -11
- data/lib/ionoscloud/models/group_entities.rb +23 -5
- data/lib/ionoscloud/models/group_members.rb +47 -15
- data/lib/ionoscloud/models/group_properties.rb +133 -27
- data/lib/ionoscloud/models/group_share.rb +43 -9
- data/lib/ionoscloud/models/group_share_properties.rb +23 -5
- data/lib/ionoscloud/models/group_shares.rb +46 -14
- data/lib/ionoscloud/models/group_users.rb +48 -16
- data/lib/ionoscloud/models/groups.rb +47 -15
- data/lib/ionoscloud/models/image.rb +53 -11
- data/lib/ionoscloud/models/image_properties.rb +199 -47
- data/lib/ionoscloud/models/images.rb +47 -15
- data/lib/ionoscloud/models/info.rb +32 -6
- data/lib/ionoscloud/models/ip_block.rb +53 -11
- data/lib/ionoscloud/models/ip_block_properties.rb +59 -21
- data/lib/ionoscloud/models/ip_blocks.rb +103 -18
- data/lib/ionoscloud/models/ip_consumer.rb +86 -12
- data/lib/ionoscloud/models/ip_failover.rb +23 -5
- data/lib/ionoscloud/models/kubernetes_auto_scaling.rb +23 -5
- data/lib/ionoscloud/models/kubernetes_cluster.rb +61 -11
- data/lib/ionoscloud/models/kubernetes_cluster_entities.rb +14 -4
- data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +61 -11
- data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +61 -11
- data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +99 -27
- data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +77 -17
- data/lib/ionoscloud/models/kubernetes_cluster_properties_for_put.rb +73 -11
- data/lib/ionoscloud/models/kubernetes_clusters.rb +47 -15
- data/lib/ionoscloud/models/kubernetes_maintenance_window.rb +23 -5
- data/lib/ionoscloud/models/kubernetes_node.rb +52 -10
- data/lib/ionoscloud/models/kubernetes_node_metadata.rb +54 -12
- data/lib/ionoscloud/models/kubernetes_node_pool.rb +52 -10
- data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +52 -10
- data/lib/ionoscloud/models/kubernetes_node_pool_for_put.rb +52 -10
- data/lib/ionoscloud/models/kubernetes_node_pool_lan.rb +40 -11
- data/lib/ionoscloud/models/kubernetes_node_pool_lan_routes.rb +23 -5
- data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +202 -56
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +190 -50
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +99 -38
- data/lib/ionoscloud/models/kubernetes_node_pools.rb +47 -15
- data/lib/ionoscloud/models/kubernetes_node_properties.rb +43 -9
- data/lib/ionoscloud/models/kubernetes_nodes.rb +47 -15
- data/lib/ionoscloud/models/label.rb +52 -10
- data/lib/ionoscloud/models/label_properties.rb +53 -11
- data/lib/ionoscloud/models/label_resource.rb +52 -10
- data/lib/ionoscloud/models/label_resource_properties.rb +25 -7
- data/lib/ionoscloud/models/label_resources.rb +76 -20
- data/lib/ionoscloud/models/labels.rb +47 -15
- data/lib/ionoscloud/models/lan.rb +62 -12
- data/lib/ionoscloud/models/lan_entities.rb +14 -4
- data/lib/ionoscloud/models/lan_nics.rb +76 -20
- data/lib/ionoscloud/models/lan_post.rb +62 -12
- data/lib/ionoscloud/models/lan_properties.rb +46 -14
- data/lib/ionoscloud/models/lan_properties_post.rb +46 -14
- data/lib/ionoscloud/models/lans.rb +76 -20
- data/lib/ionoscloud/models/loadbalancer.rb +62 -12
- data/lib/ionoscloud/models/loadbalancer_entities.rb +14 -4
- data/lib/ionoscloud/models/loadbalancer_properties.rb +36 -9
- data/lib/ionoscloud/models/loadbalancers.rb +76 -20
- data/lib/ionoscloud/models/location.rb +53 -11
- data/lib/ionoscloud/models/location_properties.rb +48 -20
- data/lib/ionoscloud/models/locations.rb +47 -15
- data/lib/ionoscloud/models/nat_gateway.rb +62 -12
- data/lib/ionoscloud/models/nat_gateway_entities.rb +23 -5
- data/lib/ionoscloud/models/nat_gateway_lan_properties.rb +27 -11
- data/lib/ionoscloud/models/nat_gateway_properties.rb +39 -17
- data/lib/ionoscloud/models/nat_gateway_put.rb +44 -10
- data/lib/ionoscloud/models/nat_gateway_rule.rb +53 -11
- data/lib/ionoscloud/models/nat_gateway_rule_properties.rb +74 -16
- data/lib/ionoscloud/models/nat_gateway_rule_protocol.rb +3 -3
- data/lib/ionoscloud/models/nat_gateway_rule_put.rb +44 -10
- data/lib/ionoscloud/models/nat_gateway_rule_type.rb +3 -3
- data/lib/ionoscloud/models/nat_gateway_rules.rb +47 -15
- data/lib/ionoscloud/models/nat_gateways.rb +76 -20
- data/lib/ionoscloud/models/network_load_balancer.rb +62 -12
- data/lib/ionoscloud/models/network_load_balancer_entities.rb +23 -5
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule.rb +53 -11
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_health_check.rb +44 -20
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_properties.rb +78 -22
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_put.rb +44 -10
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target.rb +44 -10
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rule_target_health_check.rb +35 -9
- data/lib/ionoscloud/models/network_load_balancer_forwarding_rules.rb +76 -20
- data/lib/ionoscloud/models/network_load_balancer_properties.rb +59 -21
- data/lib/ionoscloud/models/network_load_balancer_put.rb +44 -10
- data/lib/ionoscloud/models/network_load_balancers.rb +76 -20
- data/lib/ionoscloud/models/nic.rb +62 -12
- data/lib/ionoscloud/models/nic_entities.rb +23 -5
- data/lib/ionoscloud/models/nic_properties.rb +98 -25
- data/lib/ionoscloud/models/nic_put.rb +44 -10
- data/lib/ionoscloud/models/nics.rb +76 -20
- data/lib/ionoscloud/models/no_state_meta_data.rb +73 -15
- data/lib/ionoscloud/models/pagination_links.rb +35 -9
- data/lib/ionoscloud/models/peer.rb +50 -8
- data/lib/ionoscloud/models/private_cross_connect.rb +53 -11
- data/lib/ionoscloud/models/private_cross_connect_properties.rb +49 -19
- data/lib/ionoscloud/models/private_cross_connects.rb +47 -15
- data/lib/ionoscloud/models/remote_console_url.rb +14 -4
- data/lib/ionoscloud/models/request.rb +53 -11
- data/lib/ionoscloud/models/request_metadata.rb +43 -9
- data/lib/ionoscloud/models/request_properties.rb +43 -11
- data/lib/ionoscloud/models/request_status.rb +44 -10
- data/lib/ionoscloud/models/request_status_metadata.rb +44 -12
- data/lib/ionoscloud/models/request_target.rb +23 -5
- data/lib/ionoscloud/models/requests.rb +76 -20
- data/lib/ionoscloud/models/resource.rb +62 -12
- data/lib/ionoscloud/models/resource_entities.rb +14 -4
- data/lib/ionoscloud/models/resource_groups.rb +47 -15
- data/lib/ionoscloud/models/resource_limits.rb +225 -47
- data/lib/ionoscloud/models/resource_properties.rb +25 -7
- data/lib/ionoscloud/models/resource_reference.rb +35 -9
- data/lib/ionoscloud/models/resources.rb +48 -16
- data/lib/ionoscloud/models/resources_users.rb +47 -15
- data/lib/ionoscloud/models/s3_bucket.rb +232 -0
- data/lib/ionoscloud/models/s3_key.rb +53 -11
- data/lib/ionoscloud/models/s3_key_metadata.rb +25 -7
- data/lib/ionoscloud/models/s3_key_properties.rb +25 -7
- data/lib/ionoscloud/models/s3_keys.rb +47 -15
- data/lib/ionoscloud/models/s3_object_storage_sso.rb +14 -4
- data/lib/ionoscloud/models/server.rb +62 -12
- data/lib/ionoscloud/models/server_entities.rb +32 -6
- data/lib/ionoscloud/models/server_properties.rb +102 -20
- data/lib/ionoscloud/models/servers.rb +76 -20
- data/lib/ionoscloud/models/snapshot.rb +53 -11
- data/lib/ionoscloud/models/snapshot_properties.rb +165 -35
- data/lib/ionoscloud/models/snapshots.rb +47 -15
- data/lib/ionoscloud/models/target_port_range.rb +25 -7
- data/lib/ionoscloud/models/template.rb +53 -11
- data/lib/ionoscloud/models/template_properties.rb +45 -11
- data/lib/ionoscloud/models/templates.rb +47 -15
- data/lib/ionoscloud/models/token.rb +15 -5
- data/lib/ionoscloud/models/type.rb +5 -5
- data/lib/ionoscloud/models/user.rb +62 -12
- data/lib/ionoscloud/models/user_metadata.rb +35 -9
- data/lib/ionoscloud/models/user_post.rb +14 -4
- data/lib/ionoscloud/models/user_properties.rb +85 -19
- data/lib/ionoscloud/models/user_properties_post.rb +85 -19
- data/lib/ionoscloud/models/user_properties_put.rb +94 -18
- data/lib/ionoscloud/models/user_put.rb +24 -6
- data/lib/ionoscloud/models/users.rb +103 -18
- data/lib/ionoscloud/models/users_entities.rb +23 -5
- data/lib/ionoscloud/models/volume.rb +53 -11
- data/lib/ionoscloud/models/volume_properties.rb +240 -53
- data/lib/ionoscloud/models/volumes.rb +76 -20
- data/lib/ionoscloud/version.rb +4 -4
- data/lib/ionoscloud.rb +5 -4
- data/lib/test_driver.rb +119 -0
- data/sonar-project.properties +12 -0
- data/spec/api_client_spec.rb +3 -3
- data/spec/configuration_spec.rb +3 -3
- data/spec/spec_helper.rb +3 -3
- metadata +211 -590
- data/docs/DataCentersApi.md +0 -516
- data/docs/DefaultApi.md +0 -78
- data/docs/IPBlocksApi.md +0 -512
- data/docs/ImageProperties.md +0 -54
- data/docs/ImagesApi.md +0 -428
- data/docs/IpBlocks.md +0 -24
- data/docs/KubernetesClusterPropertiesForPost.md +0 -26
- data/docs/KubernetesClusterPropertiesForPut.md +0 -22
- data/docs/KubernetesNodePoolPropertiesForPost.md +0 -48
- data/docs/LabelsApi.md +0 -2346
- data/docs/LansApi.md +0 -794
- data/docs/LocationsApi.md +0 -259
- data/docs/NetworkLoadBalancerForwardingRuleHealthCheck.md +0 -26
- data/docs/NetworkLoadBalancerForwardingRuleTarget.md +0 -24
- data/docs/NetworkLoadBalancerForwardingRuleTargetHealthCheck.md +0 -22
- data/docs/NetworkLoadBalancerProperties.md +0 -26
- data/docs/NicProperties.md +0 -34
- data/docs/PrivateCrossConnectsApi.md +0 -430
- data/docs/RequestsApi.md +0 -283
- data/docs/ResourceLimits.md +0 -60
- data/docs/ServersApi.md +0 -1908
- data/docs/SnapshotProperties.md +0 -48
- data/docs/SnapshotsApi.md +0 -428
- data/docs/UserManagementApi.md +0 -2033
- data/docs/UserProperties.md +0 -32
- data/docs/UserPropertiesPost.md +0 -32
- data/docs/UserPropertiesPut.md +0 -30
- data/docs/UserS3KeysApi.md +0 -516
- data/docs/Users.md +0 -24
- data/docs/VolumesApi.md +0 -709
- data/spec/api/_api_spec.rb +0 -49
- data/spec/api/backup_units_api_spec.rb +0 -140
- data/spec/api/contract_resources_api_spec.rb +0 -49
- data/spec/api/data_centers_api_spec.rb +0 -128
- data/spec/api/firewall_rules_api_spec.rb +0 -146
- data/spec/api/flow_logs_api_spec.rb +0 -140
- data/spec/api/images_api_spec.rb +0 -111
- data/spec/api/ip_blocks_api_spec.rb +0 -126
- data/spec/api/kubernetes_api_spec.rb +0 -294
- data/spec/api/labels_api_spec.rb +0 -478
- data/spec/api/lans_api_spec.rb +0 -186
- data/spec/api/load_balancers_api_spec.rb +0 -205
- data/spec/api/locations_api_spec.rb +0 -80
- data/spec/api/nat_gateways_api_spec.rb +0 -336
- data/spec/api/network_interfaces_api_spec.rb +0 -140
- data/spec/api/network_load_balancers_api_spec.rb +0 -342
- data/spec/api/private_cross_connects_api_spec.rb +0 -112
- data/spec/api/requests_api_spec.rb +0 -92
- data/spec/api/servers_api_spec.rb +0 -401
- data/spec/api/snapshots_api_spec.rb +0 -111
- data/spec/api/templates_api_spec.rb +0 -60
- data/spec/api/user_management_api_spec.rb +0 -402
- data/spec/api/user_s3_keys_api_spec.rb +0 -128
- data/spec/api/volumes_api_spec.rb +0 -171
- data/spec/models/attached_volumes_spec.rb +0 -70
- data/spec/models/backup_unit_properties_spec.rb +0 -46
- data/spec/models/backup_unit_spec.rb +0 -62
- data/spec/models/backup_unit_sso_spec.rb +0 -34
- data/spec/models/backup_units_spec.rb +0 -56
- data/spec/models/balanced_nics_spec.rb +0 -70
- data/spec/models/cdroms_spec.rb +0 -70
- data/spec/models/connectable_datacenter_spec.rb +0 -46
- data/spec/models/contract_properties_spec.rb +0 -58
- data/spec/models/contract_spec.rb +0 -40
- data/spec/models/contracts_spec.rb +0 -52
- data/spec/models/cpu_architecture_properties_spec.rb +0 -52
- data/spec/models/data_center_entities_spec.rb +0 -64
- data/spec/models/datacenter_element_metadata_spec.rb +0 -80
- data/spec/models/datacenter_properties_spec.rb +0 -70
- data/spec/models/datacenter_spec.rb +0 -64
- data/spec/models/datacenters_spec.rb +0 -70
- data/spec/models/error_message_spec.rb +0 -40
- data/spec/models/error_spec.rb +0 -40
- data/spec/models/firewall_rule_spec.rb +0 -58
- data/spec/models/firewall_rules_spec.rb +0 -70
- data/spec/models/firewallrule_properties_spec.rb +0 -96
- data/spec/models/flow_log_properties_spec.rb +0 -60
- data/spec/models/flow_log_put_spec.rb +0 -52
- data/spec/models/flow_log_spec.rb +0 -58
- data/spec/models/flow_logs_spec.rb +0 -70
- data/spec/models/group_entities_spec.rb +0 -40
- data/spec/models/group_members_spec.rb +0 -52
- data/spec/models/group_properties_spec.rb +0 -106
- data/spec/models/group_share_properties_spec.rb +0 -40
- data/spec/models/group_share_spec.rb +0 -52
- data/spec/models/group_shares_spec.rb +0 -52
- data/spec/models/group_spec.rb +0 -58
- data/spec/models/group_users_spec.rb +0 -52
- data/spec/models/groups_spec.rb +0 -52
- data/spec/models/image_properties_spec.rb +0 -154
- data/spec/models/image_spec.rb +0 -58
- data/spec/models/images_spec.rb +0 -52
- data/spec/models/info_spec.rb +0 -46
- data/spec/models/ip_block_properties_spec.rb +0 -58
- data/spec/models/ip_block_spec.rb +0 -58
- data/spec/models/ip_blocks_spec.rb +0 -52
- data/spec/models/ip_consumer_spec.rb +0 -82
- data/spec/models/ip_failover_spec.rb +0 -40
- data/spec/models/kubernetes_auto_scaling_spec.rb +0 -40
- data/spec/models/kubernetes_cluster_entities_spec.rb +0 -34
- data/spec/models/kubernetes_cluster_for_post_spec.rb +0 -68
- data/spec/models/kubernetes_cluster_for_put_spec.rb +0 -68
- data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +0 -58
- data/spec/models/kubernetes_cluster_properties_for_put_spec.rb +0 -46
- data/spec/models/kubernetes_cluster_properties_spec.rb +0 -70
- data/spec/models/kubernetes_cluster_spec.rb +0 -68
- data/spec/models/kubernetes_clusters_spec.rb +0 -56
- data/spec/models/kubernetes_maintenance_window_spec.rb +0 -44
- data/spec/models/kubernetes_node_metadata_spec.rb +0 -62
- data/spec/models/kubernetes_node_pool_for_post_spec.rb +0 -62
- data/spec/models/kubernetes_node_pool_for_put_spec.rb +0 -62
- data/spec/models/kubernetes_node_pool_lan_routes_spec.rb +0 -40
- data/spec/models/kubernetes_node_pool_lan_spec.rb +0 -46
- data/spec/models/kubernetes_node_pool_properties_for_post_spec.rb +0 -132
- data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +0 -82
- data/spec/models/kubernetes_node_pool_properties_spec.rb +0 -138
- data/spec/models/kubernetes_node_pool_spec.rb +0 -62
- data/spec/models/kubernetes_node_pools_spec.rb +0 -56
- data/spec/models/kubernetes_node_properties_spec.rb +0 -52
- data/spec/models/kubernetes_node_spec.rb +0 -62
- data/spec/models/kubernetes_nodes_spec.rb +0 -56
- data/spec/models/label_properties_spec.rb +0 -58
- data/spec/models/label_resource_properties_spec.rb +0 -40
- data/spec/models/label_resource_spec.rb +0 -62
- data/spec/models/label_resources_spec.rb +0 -74
- data/spec/models/label_spec.rb +0 -62
- data/spec/models/labels_spec.rb +0 -56
- data/spec/models/lan_entities_spec.rb +0 -34
- data/spec/models/lan_nics_spec.rb +0 -70
- data/spec/models/lan_post_spec.rb +0 -64
- data/spec/models/lan_properties_post_spec.rb +0 -52
- data/spec/models/lan_properties_spec.rb +0 -52
- data/spec/models/lan_spec.rb +0 -64
- data/spec/models/lans_spec.rb +0 -70
- data/spec/models/loadbalancer_entities_spec.rb +0 -34
- data/spec/models/loadbalancer_properties_spec.rb +0 -46
- data/spec/models/loadbalancer_spec.rb +0 -64
- data/spec/models/loadbalancers_spec.rb +0 -70
- data/spec/models/location_properties_spec.rb +0 -52
- data/spec/models/location_spec.rb +0 -58
- data/spec/models/locations_spec.rb +0 -52
- data/spec/models/nat_gateway_entities_spec.rb +0 -40
- data/spec/models/nat_gateway_lan_properties_spec.rb +0 -40
- data/spec/models/nat_gateway_properties_spec.rb +0 -46
- data/spec/models/nat_gateway_put_spec.rb +0 -52
- data/spec/models/nat_gateway_rule_properties_spec.rb +0 -70
- data/spec/models/nat_gateway_rule_protocol_spec.rb +0 -28
- data/spec/models/nat_gateway_rule_put_spec.rb +0 -52
- data/spec/models/nat_gateway_rule_spec.rb +0 -58
- data/spec/models/nat_gateway_rule_type_spec.rb +0 -28
- data/spec/models/nat_gateway_rules_spec.rb +0 -52
- data/spec/models/nat_gateway_spec.rb +0 -64
- data/spec/models/nat_gateways_spec.rb +0 -70
- data/spec/models/network_load_balancer_entities_spec.rb +0 -40
- data/spec/models/network_load_balancer_forwarding_rule_health_check_spec.rb +0 -58
- data/spec/models/network_load_balancer_forwarding_rule_properties_spec.rb +0 -78
- data/spec/models/network_load_balancer_forwarding_rule_put_spec.rb +0 -52
- data/spec/models/network_load_balancer_forwarding_rule_spec.rb +0 -58
- data/spec/models/network_load_balancer_forwarding_rule_target_health_check_spec.rb +0 -46
- data/spec/models/network_load_balancer_forwarding_rule_target_spec.rb +0 -52
- data/spec/models/network_load_balancer_forwarding_rules_spec.rb +0 -70
- data/spec/models/network_load_balancer_properties_spec.rb +0 -58
- data/spec/models/network_load_balancer_put_spec.rb +0 -52
- data/spec/models/network_load_balancer_spec.rb +0 -64
- data/spec/models/network_load_balancers_spec.rb +0 -70
- data/spec/models/nic_entities_spec.rb +0 -40
- data/spec/models/nic_properties_spec.rb +0 -86
- data/spec/models/nic_put_spec.rb +0 -52
- data/spec/models/nic_spec.rb +0 -64
- data/spec/models/nics_spec.rb +0 -70
- data/spec/models/no_state_meta_data_spec.rb +0 -70
- data/spec/models/pagination_links_spec.rb +0 -46
- data/spec/models/peer_spec.rb +0 -58
- data/spec/models/private_cross_connect_properties_spec.rb +0 -52
- data/spec/models/private_cross_connect_spec.rb +0 -58
- data/spec/models/private_cross_connects_spec.rb +0 -52
- data/spec/models/remote_console_url_spec.rb +0 -34
- data/spec/models/request_metadata_spec.rb +0 -52
- data/spec/models/request_properties_spec.rb +0 -52
- data/spec/models/request_spec.rb +0 -58
- data/spec/models/request_status_metadata_spec.rb +0 -56
- data/spec/models/request_status_spec.rb +0 -52
- data/spec/models/request_target_spec.rb +0 -44
- data/spec/models/requests_spec.rb +0 -70
- data/spec/models/resource_entities_spec.rb +0 -34
- data/spec/models/resource_groups_spec.rb +0 -52
- data/spec/models/resource_limits_spec.rb +0 -160
- data/spec/models/resource_properties_spec.rb +0 -40
- data/spec/models/resource_reference_spec.rb +0 -46
- data/spec/models/resource_spec.rb +0 -64
- data/spec/models/resources_spec.rb +0 -52
- data/spec/models/resources_users_spec.rb +0 -52
- data/spec/models/s3_key_metadata_spec.rb +0 -40
- data/spec/models/s3_key_properties_spec.rb +0 -40
- data/spec/models/s3_key_spec.rb +0 -58
- data/spec/models/s3_keys_spec.rb +0 -52
- data/spec/models/s3_object_storage_sso_spec.rb +0 -34
- data/spec/models/server_entities_spec.rb +0 -46
- data/spec/models/server_properties_spec.rb +0 -96
- data/spec/models/server_spec.rb +0 -64
- data/spec/models/servers_spec.rb +0 -70
- data/spec/models/snapshot_properties_spec.rb +0 -128
- data/spec/models/snapshot_spec.rb +0 -58
- data/spec/models/snapshots_spec.rb +0 -52
- data/spec/models/target_port_range_spec.rb +0 -40
- data/spec/models/template_properties_spec.rb +0 -52
- data/spec/models/template_spec.rb +0 -58
- data/spec/models/templates_spec.rb +0 -52
- data/spec/models/token_spec.rb +0 -34
- data/spec/models/type_spec.rb +0 -28
- data/spec/models/user_metadata_spec.rb +0 -46
- data/spec/models/user_post_spec.rb +0 -34
- data/spec/models/user_properties_post_spec.rb +0 -76
- data/spec/models/user_properties_put_spec.rb +0 -70
- data/spec/models/user_properties_spec.rb +0 -76
- data/spec/models/user_put_spec.rb +0 -40
- data/spec/models/user_spec.rb +0 -64
- data/spec/models/users_entities_spec.rb +0 -40
- data/spec/models/users_spec.rb +0 -52
- data/spec/models/volume_properties_spec.rb +0 -158
- data/spec/models/volume_spec.rb +0 -58
- data/spec/models/volumes_spec.rb +0 -70
|
@@ -0,0 +1,709 @@
|
|
|
1
|
+
# VolumesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.ionos.com/cloudapi/v6*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**datacenters_volumes_create_snapshot_post**](VolumesApi.md#datacenters_volumes_create_snapshot_post) | **POST** /datacenters/{datacenterId}/volumes/{volumeId}/create-snapshot | Create volume snapshots |
|
|
8
|
+
| [**datacenters_volumes_delete**](VolumesApi.md#datacenters_volumes_delete) | **DELETE** /datacenters/{datacenterId}/volumes/{volumeId} | Delete volumes |
|
|
9
|
+
| [**datacenters_volumes_find_by_id**](VolumesApi.md#datacenters_volumes_find_by_id) | **GET** /datacenters/{datacenterId}/volumes/{volumeId} | Retrieve volumes |
|
|
10
|
+
| [**datacenters_volumes_get**](VolumesApi.md#datacenters_volumes_get) | **GET** /datacenters/{datacenterId}/volumes | List volumes |
|
|
11
|
+
| [**datacenters_volumes_patch**](VolumesApi.md#datacenters_volumes_patch) | **PATCH** /datacenters/{datacenterId}/volumes/{volumeId} | Partially modify volumes |
|
|
12
|
+
| [**datacenters_volumes_post**](VolumesApi.md#datacenters_volumes_post) | **POST** /datacenters/{datacenterId}/volumes | Create volumes |
|
|
13
|
+
| [**datacenters_volumes_put**](VolumesApi.md#datacenters_volumes_put) | **PUT** /datacenters/{datacenterId}/volumes/{volumeId} | Modify volumes |
|
|
14
|
+
| [**datacenters_volumes_restore_snapshot_post**](VolumesApi.md#datacenters_volumes_restore_snapshot_post) | **POST** /datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshot | Restore volume snapshots |
|
|
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 snapshots
|
|
22
|
+
|
|
23
|
+
Create a snapshot of the specified volume within the data center; this snapshot can later be used to restore this 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::VolumesApi.new
|
|
43
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
44
|
+
volume_id = 'volume_id_example' # String | The unique ID of the volume.
|
|
45
|
+
opts = {
|
|
46
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
47
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
|
49
|
+
name: 'name_example', # String | Snapshot name
|
|
50
|
+
description: 'description_example', # String | Snapshot description
|
|
51
|
+
sec_auth_protection: true, # Boolean | Flag for enabling extra protection for this snapshot, such as two-step verification.
|
|
52
|
+
licence_type: 'UNKNOWN' # String | The OS type for this snapshot.
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
begin
|
|
56
|
+
# Create volume snapshots
|
|
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 VolumesApi->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 snapshots
|
|
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 VolumesApi->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 data center. | |
|
|
87
|
+
| **volume_id** | **String** | The unique ID of the volume. | |
|
|
88
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
89
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
|
91
|
+
| **name** | **String** | Snapshot name | [optional] |
|
|
92
|
+
| **description** | **String** | Snapshot description | [optional] |
|
|
93
|
+
| **sec_auth_protection** | **Boolean** | Flag for enabling extra protection for this snapshot, such as two-step verification. | [optional] |
|
|
94
|
+
| **licence_type** | **String** | The OS type for this snapshot. | [optional] |
|
|
95
|
+
|
|
96
|
+
### Return type
|
|
97
|
+
|
|
98
|
+
[**Snapshot**](../models/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
|
+
> datacenters_volumes_delete(datacenter_id, volume_id, opts)
|
|
113
|
+
|
|
114
|
+
Delete volumes
|
|
115
|
+
|
|
116
|
+
Delete the specified volume within the data center. Use with caution, the volume will be permanently removed!
|
|
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::VolumesApi.new
|
|
136
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
137
|
+
volume_id = 'volume_id_example' # String | The unique ID of the volume.
|
|
138
|
+
opts = {
|
|
139
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
140
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
begin
|
|
145
|
+
# Delete volumes
|
|
146
|
+
api_instance.datacenters_volumes_delete(datacenter_id, volume_id, opts)
|
|
147
|
+
rescue Ionoscloud::ApiError => e
|
|
148
|
+
puts "Error when calling VolumesApi->datacenters_volumes_delete: #{e}"
|
|
149
|
+
end
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
#### Using the datacenters_volumes_delete_with_http_info variant
|
|
153
|
+
|
|
154
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
155
|
+
|
|
156
|
+
> <Array(nil, Integer, Hash)> datacenters_volumes_delete_with_http_info(datacenter_id, volume_id, opts)
|
|
157
|
+
|
|
158
|
+
```ruby
|
|
159
|
+
begin
|
|
160
|
+
# Delete volumes
|
|
161
|
+
data, status_code, headers = api_instance.datacenters_volumes_delete_with_http_info(datacenter_id, volume_id, opts)
|
|
162
|
+
p status_code # => 2xx
|
|
163
|
+
p headers # => { ... }
|
|
164
|
+
p data # => nil
|
|
165
|
+
rescue Ionoscloud::ApiError => e
|
|
166
|
+
puts "Error when calling VolumesApi->datacenters_volumes_delete_with_http_info: #{e}"
|
|
167
|
+
end
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Parameters
|
|
171
|
+
|
|
172
|
+
| Name | Type | Description | Notes |
|
|
173
|
+
| ---- | ---- | ----------- | ----- |
|
|
174
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
175
|
+
| **volume_id** | **String** | The unique ID of the volume. | |
|
|
176
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
177
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] |
|
|
178
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
|
179
|
+
|
|
180
|
+
### Return type
|
|
181
|
+
|
|
182
|
+
nil (empty response body)
|
|
183
|
+
|
|
184
|
+
### Authorization
|
|
185
|
+
|
|
186
|
+
Basic Authentication, Token Authentication
|
|
187
|
+
|
|
188
|
+
### HTTP request headers
|
|
189
|
+
|
|
190
|
+
- **Content-Type**: Not defined
|
|
191
|
+
- **Accept**: application/json
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
## datacenters_volumes_find_by_id
|
|
195
|
+
|
|
196
|
+
> <Volume> datacenters_volumes_find_by_id(datacenter_id, volume_id, opts)
|
|
197
|
+
|
|
198
|
+
Retrieve volumes
|
|
199
|
+
|
|
200
|
+
Retrieve the properties of the specified volume within the data center.
|
|
201
|
+
|
|
202
|
+
### Examples
|
|
203
|
+
|
|
204
|
+
```ruby
|
|
205
|
+
require 'time'
|
|
206
|
+
require 'ionoscloud'
|
|
207
|
+
# setup authorization
|
|
208
|
+
Ionoscloud.configure do |config|
|
|
209
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
210
|
+
config.username = 'YOUR USERNAME'
|
|
211
|
+
config.password = 'YOUR PASSWORD'
|
|
212
|
+
|
|
213
|
+
# Configure API key authorization: Token Authentication
|
|
214
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
215
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
216
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
api_instance = Ionoscloud::VolumesApi.new
|
|
220
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
221
|
+
volume_id = 'volume_id_example' # String | The unique ID of the volume.
|
|
222
|
+
opts = {
|
|
223
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
224
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
|
|
225
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
begin
|
|
229
|
+
# Retrieve volumes
|
|
230
|
+
result = api_instance.datacenters_volumes_find_by_id(datacenter_id, volume_id, opts)
|
|
231
|
+
p result
|
|
232
|
+
rescue Ionoscloud::ApiError => e
|
|
233
|
+
puts "Error when calling VolumesApi->datacenters_volumes_find_by_id: #{e}"
|
|
234
|
+
end
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
#### Using the datacenters_volumes_find_by_id_with_http_info variant
|
|
238
|
+
|
|
239
|
+
This returns an Array which contains the response data, status code and headers.
|
|
240
|
+
|
|
241
|
+
> <Array(<Volume>, Integer, Hash)> datacenters_volumes_find_by_id_with_http_info(datacenter_id, volume_id, opts)
|
|
242
|
+
|
|
243
|
+
```ruby
|
|
244
|
+
begin
|
|
245
|
+
# Retrieve volumes
|
|
246
|
+
data, status_code, headers = api_instance.datacenters_volumes_find_by_id_with_http_info(datacenter_id, volume_id, opts)
|
|
247
|
+
p status_code # => 2xx
|
|
248
|
+
p headers # => { ... }
|
|
249
|
+
p data # => <Volume>
|
|
250
|
+
rescue Ionoscloud::ApiError => e
|
|
251
|
+
puts "Error when calling VolumesApi->datacenters_volumes_find_by_id_with_http_info: #{e}"
|
|
252
|
+
end
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
### Parameters
|
|
256
|
+
|
|
257
|
+
| Name | Type | Description | Notes |
|
|
258
|
+
| ---- | ---- | ----------- | ----- |
|
|
259
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
260
|
+
| **volume_id** | **String** | The unique ID of the volume. | |
|
|
261
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
262
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] |
|
|
263
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
|
264
|
+
|
|
265
|
+
### Return type
|
|
266
|
+
|
|
267
|
+
[**Volume**](../models/Volume.md)
|
|
268
|
+
|
|
269
|
+
### Authorization
|
|
270
|
+
|
|
271
|
+
Basic Authentication, Token Authentication
|
|
272
|
+
|
|
273
|
+
### HTTP request headers
|
|
274
|
+
|
|
275
|
+
- **Content-Type**: Not defined
|
|
276
|
+
- **Accept**: application/json
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
## datacenters_volumes_get
|
|
280
|
+
|
|
281
|
+
> <Volumes> datacenters_volumes_get(datacenter_id, opts)
|
|
282
|
+
|
|
283
|
+
List volumes
|
|
284
|
+
|
|
285
|
+
List all the volumes within the data center.
|
|
286
|
+
|
|
287
|
+
### Examples
|
|
288
|
+
|
|
289
|
+
```ruby
|
|
290
|
+
require 'time'
|
|
291
|
+
require 'ionoscloud'
|
|
292
|
+
# setup authorization
|
|
293
|
+
Ionoscloud.configure do |config|
|
|
294
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
295
|
+
config.username = 'YOUR USERNAME'
|
|
296
|
+
config.password = 'YOUR PASSWORD'
|
|
297
|
+
|
|
298
|
+
# Configure API key authorization: Token Authentication
|
|
299
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
300
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
301
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
302
|
+
end
|
|
303
|
+
|
|
304
|
+
api_instance = Ionoscloud::VolumesApi.new
|
|
305
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
306
|
+
opts = {
|
|
307
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
308
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
|
|
309
|
+
x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
|
310
|
+
offset: 56, # Integer | The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination).
|
|
311
|
+
limit: 56 # Integer | The maximum number of elements to return (use together with offset for pagination).
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
begin
|
|
315
|
+
# List volumes
|
|
316
|
+
result = api_instance.datacenters_volumes_get(datacenter_id, opts)
|
|
317
|
+
p result
|
|
318
|
+
rescue Ionoscloud::ApiError => e
|
|
319
|
+
puts "Error when calling VolumesApi->datacenters_volumes_get: #{e}"
|
|
320
|
+
end
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
#### Using the datacenters_volumes_get_with_http_info variant
|
|
324
|
+
|
|
325
|
+
This returns an Array which contains the response data, status code and headers.
|
|
326
|
+
|
|
327
|
+
> <Array(<Volumes>, Integer, Hash)> datacenters_volumes_get_with_http_info(datacenter_id, opts)
|
|
328
|
+
|
|
329
|
+
```ruby
|
|
330
|
+
begin
|
|
331
|
+
# List volumes
|
|
332
|
+
data, status_code, headers = api_instance.datacenters_volumes_get_with_http_info(datacenter_id, opts)
|
|
333
|
+
p status_code # => 2xx
|
|
334
|
+
p headers # => { ... }
|
|
335
|
+
p data # => <Volumes>
|
|
336
|
+
rescue Ionoscloud::ApiError => e
|
|
337
|
+
puts "Error when calling VolumesApi->datacenters_volumes_get_with_http_info: #{e}"
|
|
338
|
+
end
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### Parameters
|
|
342
|
+
|
|
343
|
+
| Name | Type | Description | Notes |
|
|
344
|
+
| ---- | ---- | ----------- | ----- |
|
|
345
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
346
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
347
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] |
|
|
348
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
|
349
|
+
| **offset** | **Integer** | The first element (from the complete list of the elements) to include in the response (used together with <b><i>limit</i></b> for pagination). | [optional][default to 0] |
|
|
350
|
+
| **limit** | **Integer** | The maximum number of elements to return (use together with offset for pagination). | [optional][default to 1000] |
|
|
351
|
+
|
|
352
|
+
### Return type
|
|
353
|
+
|
|
354
|
+
[**Volumes**](../models/Volumes.md)
|
|
355
|
+
|
|
356
|
+
### Authorization
|
|
357
|
+
|
|
358
|
+
Basic Authentication, Token Authentication
|
|
359
|
+
|
|
360
|
+
### HTTP request headers
|
|
361
|
+
|
|
362
|
+
- **Content-Type**: Not defined
|
|
363
|
+
- **Accept**: application/json
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
## datacenters_volumes_patch
|
|
367
|
+
|
|
368
|
+
> <Volume> datacenters_volumes_patch(datacenter_id, volume_id, volume, opts)
|
|
369
|
+
|
|
370
|
+
Partially modify volumes
|
|
371
|
+
|
|
372
|
+
Update the properties of the specified storage volume within the data center.
|
|
373
|
+
|
|
374
|
+
### Examples
|
|
375
|
+
|
|
376
|
+
```ruby
|
|
377
|
+
require 'time'
|
|
378
|
+
require 'ionoscloud'
|
|
379
|
+
# setup authorization
|
|
380
|
+
Ionoscloud.configure do |config|
|
|
381
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
382
|
+
config.username = 'YOUR USERNAME'
|
|
383
|
+
config.password = 'YOUR PASSWORD'
|
|
384
|
+
|
|
385
|
+
# Configure API key authorization: Token Authentication
|
|
386
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
387
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
388
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
389
|
+
end
|
|
390
|
+
|
|
391
|
+
api_instance = Ionoscloud::VolumesApi.new
|
|
392
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
393
|
+
volume_id = 'volume_id_example' # String | The unique ID of the volume.
|
|
394
|
+
volume = Ionoscloud::VolumeProperties.new({size: 100.0}) # VolumeProperties | The properties of the volume to be updated.
|
|
395
|
+
opts = {
|
|
396
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
397
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
|
|
398
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
|
399
|
+
}
|
|
400
|
+
|
|
401
|
+
begin
|
|
402
|
+
# Partially modify volumes
|
|
403
|
+
result = api_instance.datacenters_volumes_patch(datacenter_id, volume_id, volume, opts)
|
|
404
|
+
p result
|
|
405
|
+
rescue Ionoscloud::ApiError => e
|
|
406
|
+
puts "Error when calling VolumesApi->datacenters_volumes_patch: #{e}"
|
|
407
|
+
end
|
|
408
|
+
```
|
|
409
|
+
|
|
410
|
+
#### Using the datacenters_volumes_patch_with_http_info variant
|
|
411
|
+
|
|
412
|
+
This returns an Array which contains the response data, status code and headers.
|
|
413
|
+
|
|
414
|
+
> <Array(<Volume>, Integer, Hash)> datacenters_volumes_patch_with_http_info(datacenter_id, volume_id, volume, opts)
|
|
415
|
+
|
|
416
|
+
```ruby
|
|
417
|
+
begin
|
|
418
|
+
# Partially modify volumes
|
|
419
|
+
data, status_code, headers = api_instance.datacenters_volumes_patch_with_http_info(datacenter_id, volume_id, volume, opts)
|
|
420
|
+
p status_code # => 2xx
|
|
421
|
+
p headers # => { ... }
|
|
422
|
+
p data # => <Volume>
|
|
423
|
+
rescue Ionoscloud::ApiError => e
|
|
424
|
+
puts "Error when calling VolumesApi->datacenters_volumes_patch_with_http_info: #{e}"
|
|
425
|
+
end
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
### Parameters
|
|
429
|
+
|
|
430
|
+
| Name | Type | Description | Notes |
|
|
431
|
+
| ---- | ---- | ----------- | ----- |
|
|
432
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
433
|
+
| **volume_id** | **String** | The unique ID of the volume. | |
|
|
434
|
+
| **volume** | [**VolumeProperties**](VolumeProperties.md) | The properties of the volume to be updated. | |
|
|
435
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
436
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] |
|
|
437
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
|
438
|
+
|
|
439
|
+
### Return type
|
|
440
|
+
|
|
441
|
+
[**Volume**](../models/Volume.md)
|
|
442
|
+
|
|
443
|
+
### Authorization
|
|
444
|
+
|
|
445
|
+
Basic Authentication, Token Authentication
|
|
446
|
+
|
|
447
|
+
### HTTP request headers
|
|
448
|
+
|
|
449
|
+
- **Content-Type**: application/json
|
|
450
|
+
- **Accept**: application/json
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
## datacenters_volumes_post
|
|
454
|
+
|
|
455
|
+
> <Volume> datacenters_volumes_post(datacenter_id, volume, opts)
|
|
456
|
+
|
|
457
|
+
Create volumes
|
|
458
|
+
|
|
459
|
+
Create a storage volume within the specified data center. The volume will not be attached! Attaching volumes is described in the Servers section.
|
|
460
|
+
|
|
461
|
+
### Examples
|
|
462
|
+
|
|
463
|
+
```ruby
|
|
464
|
+
require 'time'
|
|
465
|
+
require 'ionoscloud'
|
|
466
|
+
# setup authorization
|
|
467
|
+
Ionoscloud.configure do |config|
|
|
468
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
469
|
+
config.username = 'YOUR USERNAME'
|
|
470
|
+
config.password = 'YOUR PASSWORD'
|
|
471
|
+
|
|
472
|
+
# Configure API key authorization: Token Authentication
|
|
473
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
474
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
475
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
476
|
+
end
|
|
477
|
+
|
|
478
|
+
api_instance = Ionoscloud::VolumesApi.new
|
|
479
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
480
|
+
volume = Ionoscloud::Volume.new({properties: Ionoscloud::VolumeProperties.new({size: 100.0})}) # Volume | The volume to create.
|
|
481
|
+
opts = {
|
|
482
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
483
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
|
|
484
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
begin
|
|
488
|
+
# Create volumes
|
|
489
|
+
result = api_instance.datacenters_volumes_post(datacenter_id, volume, opts)
|
|
490
|
+
p result
|
|
491
|
+
rescue Ionoscloud::ApiError => e
|
|
492
|
+
puts "Error when calling VolumesApi->datacenters_volumes_post: #{e}"
|
|
493
|
+
end
|
|
494
|
+
```
|
|
495
|
+
|
|
496
|
+
#### Using the datacenters_volumes_post_with_http_info variant
|
|
497
|
+
|
|
498
|
+
This returns an Array which contains the response data, status code and headers.
|
|
499
|
+
|
|
500
|
+
> <Array(<Volume>, Integer, Hash)> datacenters_volumes_post_with_http_info(datacenter_id, volume, opts)
|
|
501
|
+
|
|
502
|
+
```ruby
|
|
503
|
+
begin
|
|
504
|
+
# Create volumes
|
|
505
|
+
data, status_code, headers = api_instance.datacenters_volumes_post_with_http_info(datacenter_id, volume, opts)
|
|
506
|
+
p status_code # => 2xx
|
|
507
|
+
p headers # => { ... }
|
|
508
|
+
p data # => <Volume>
|
|
509
|
+
rescue Ionoscloud::ApiError => e
|
|
510
|
+
puts "Error when calling VolumesApi->datacenters_volumes_post_with_http_info: #{e}"
|
|
511
|
+
end
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
### Parameters
|
|
515
|
+
|
|
516
|
+
| Name | Type | Description | Notes |
|
|
517
|
+
| ---- | ---- | ----------- | ----- |
|
|
518
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
519
|
+
| **volume** | [**Volume**](Volume.md) | The volume to create. | |
|
|
520
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
521
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] |
|
|
522
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
|
523
|
+
|
|
524
|
+
### Return type
|
|
525
|
+
|
|
526
|
+
[**Volume**](../models/Volume.md)
|
|
527
|
+
|
|
528
|
+
### Authorization
|
|
529
|
+
|
|
530
|
+
Basic Authentication, Token Authentication
|
|
531
|
+
|
|
532
|
+
### HTTP request headers
|
|
533
|
+
|
|
534
|
+
- **Content-Type**: application/json
|
|
535
|
+
- **Accept**: application/json
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
## datacenters_volumes_put
|
|
539
|
+
|
|
540
|
+
> <Volume> datacenters_volumes_put(datacenter_id, volume_id, volume, opts)
|
|
541
|
+
|
|
542
|
+
Modify volumes
|
|
543
|
+
|
|
544
|
+
Modify the properties of the specified volume within the data center.
|
|
545
|
+
|
|
546
|
+
### Examples
|
|
547
|
+
|
|
548
|
+
```ruby
|
|
549
|
+
require 'time'
|
|
550
|
+
require 'ionoscloud'
|
|
551
|
+
# setup authorization
|
|
552
|
+
Ionoscloud.configure do |config|
|
|
553
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
554
|
+
config.username = 'YOUR USERNAME'
|
|
555
|
+
config.password = 'YOUR PASSWORD'
|
|
556
|
+
|
|
557
|
+
# Configure API key authorization: Token Authentication
|
|
558
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
559
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
560
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
561
|
+
end
|
|
562
|
+
|
|
563
|
+
api_instance = Ionoscloud::VolumesApi.new
|
|
564
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
565
|
+
volume_id = 'volume_id_example' # String | The unique ID of the volume.
|
|
566
|
+
volume = Ionoscloud::Volume.new({properties: Ionoscloud::VolumeProperties.new({size: 100.0})}) # Volume | The modified volume
|
|
567
|
+
opts = {
|
|
568
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
569
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
|
|
570
|
+
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
|
571
|
+
}
|
|
572
|
+
|
|
573
|
+
begin
|
|
574
|
+
# Modify volumes
|
|
575
|
+
result = api_instance.datacenters_volumes_put(datacenter_id, volume_id, volume, opts)
|
|
576
|
+
p result
|
|
577
|
+
rescue Ionoscloud::ApiError => e
|
|
578
|
+
puts "Error when calling VolumesApi->datacenters_volumes_put: #{e}"
|
|
579
|
+
end
|
|
580
|
+
```
|
|
581
|
+
|
|
582
|
+
#### Using the datacenters_volumes_put_with_http_info variant
|
|
583
|
+
|
|
584
|
+
This returns an Array which contains the response data, status code and headers.
|
|
585
|
+
|
|
586
|
+
> <Array(<Volume>, Integer, Hash)> datacenters_volumes_put_with_http_info(datacenter_id, volume_id, volume, opts)
|
|
587
|
+
|
|
588
|
+
```ruby
|
|
589
|
+
begin
|
|
590
|
+
# Modify volumes
|
|
591
|
+
data, status_code, headers = api_instance.datacenters_volumes_put_with_http_info(datacenter_id, volume_id, volume, opts)
|
|
592
|
+
p status_code # => 2xx
|
|
593
|
+
p headers # => { ... }
|
|
594
|
+
p data # => <Volume>
|
|
595
|
+
rescue Ionoscloud::ApiError => e
|
|
596
|
+
puts "Error when calling VolumesApi->datacenters_volumes_put_with_http_info: #{e}"
|
|
597
|
+
end
|
|
598
|
+
```
|
|
599
|
+
|
|
600
|
+
### Parameters
|
|
601
|
+
|
|
602
|
+
| Name | Type | Description | Notes |
|
|
603
|
+
| ---- | ---- | ----------- | ----- |
|
|
604
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
605
|
+
| **volume_id** | **String** | The unique ID of the volume. | |
|
|
606
|
+
| **volume** | [**Volume**](Volume.md) | The modified volume | |
|
|
607
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
608
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] |
|
|
609
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
|
610
|
+
|
|
611
|
+
### Return type
|
|
612
|
+
|
|
613
|
+
[**Volume**](../models/Volume.md)
|
|
614
|
+
|
|
615
|
+
### Authorization
|
|
616
|
+
|
|
617
|
+
Basic Authentication, Token Authentication
|
|
618
|
+
|
|
619
|
+
### HTTP request headers
|
|
620
|
+
|
|
621
|
+
- **Content-Type**: application/json
|
|
622
|
+
- **Accept**: application/json
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
## datacenters_volumes_restore_snapshot_post
|
|
626
|
+
|
|
627
|
+
> datacenters_volumes_restore_snapshot_post(datacenter_id, volume_id, opts)
|
|
628
|
+
|
|
629
|
+
Restore volume snapshots
|
|
630
|
+
|
|
631
|
+
Restore a snapshot for the specified volume within the data center. A snapshot is an image of a volume, which can be used to restore this volume at a later time.
|
|
632
|
+
|
|
633
|
+
### Examples
|
|
634
|
+
|
|
635
|
+
```ruby
|
|
636
|
+
require 'time'
|
|
637
|
+
require 'ionoscloud'
|
|
638
|
+
# setup authorization
|
|
639
|
+
Ionoscloud.configure do |config|
|
|
640
|
+
# Configure HTTP basic authorization: Basic Authentication
|
|
641
|
+
config.username = 'YOUR USERNAME'
|
|
642
|
+
config.password = 'YOUR PASSWORD'
|
|
643
|
+
|
|
644
|
+
# Configure API key authorization: Token Authentication
|
|
645
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
646
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
647
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
648
|
+
end
|
|
649
|
+
|
|
650
|
+
api_instance = Ionoscloud::VolumesApi.new
|
|
651
|
+
datacenter_id = 'datacenter_id_example' # String | The unique ID of the data center.
|
|
652
|
+
volume_id = 'volume_id_example' # String | The unique ID of the volume.
|
|
653
|
+
opts = {
|
|
654
|
+
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
|
|
655
|
+
depth: 56, # Integer | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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
|
|
656
|
+
x_contract_number: 56, # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
|
|
657
|
+
snapshot_id: 'snapshot_id_example' # String | The unique ID of the snapshot.
|
|
658
|
+
}
|
|
659
|
+
|
|
660
|
+
begin
|
|
661
|
+
# Restore volume snapshots
|
|
662
|
+
api_instance.datacenters_volumes_restore_snapshot_post(datacenter_id, volume_id, opts)
|
|
663
|
+
rescue Ionoscloud::ApiError => e
|
|
664
|
+
puts "Error when calling VolumesApi->datacenters_volumes_restore_snapshot_post: #{e}"
|
|
665
|
+
end
|
|
666
|
+
```
|
|
667
|
+
|
|
668
|
+
#### Using the datacenters_volumes_restore_snapshot_post_with_http_info variant
|
|
669
|
+
|
|
670
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
671
|
+
|
|
672
|
+
> <Array(nil, Integer, Hash)> datacenters_volumes_restore_snapshot_post_with_http_info(datacenter_id, volume_id, opts)
|
|
673
|
+
|
|
674
|
+
```ruby
|
|
675
|
+
begin
|
|
676
|
+
# Restore volume snapshots
|
|
677
|
+
data, status_code, headers = api_instance.datacenters_volumes_restore_snapshot_post_with_http_info(datacenter_id, volume_id, opts)
|
|
678
|
+
p status_code # => 2xx
|
|
679
|
+
p headers # => { ... }
|
|
680
|
+
p data # => nil
|
|
681
|
+
rescue Ionoscloud::ApiError => e
|
|
682
|
+
puts "Error when calling VolumesApi->datacenters_volumes_restore_snapshot_post_with_http_info: #{e}"
|
|
683
|
+
end
|
|
684
|
+
```
|
|
685
|
+
|
|
686
|
+
### Parameters
|
|
687
|
+
|
|
688
|
+
| Name | Type | Description | Notes |
|
|
689
|
+
| ---- | ---- | ----------- | ----- |
|
|
690
|
+
| **datacenter_id** | **String** | The unique ID of the data center. | |
|
|
691
|
+
| **volume_id** | **String** | The unique ID of the volume. | |
|
|
692
|
+
| **pretty** | **Boolean** | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
|
|
693
|
+
| **depth** | **Integer** | Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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] |
|
|
694
|
+
| **x_contract_number** | **Integer** | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional] |
|
|
695
|
+
| **snapshot_id** | **String** | The unique ID of the snapshot. | [optional] |
|
|
696
|
+
|
|
697
|
+
### Return type
|
|
698
|
+
|
|
699
|
+
nil (empty response body)
|
|
700
|
+
|
|
701
|
+
### Authorization
|
|
702
|
+
|
|
703
|
+
Basic Authentication, Token Authentication
|
|
704
|
+
|
|
705
|
+
### HTTP request headers
|
|
706
|
+
|
|
707
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
708
|
+
- **Accept**: application/json
|
|
709
|
+
|