Categorygithub.com/ionos-cloud/sdk-go-bundle/products/compute/v2
package
2.0.1
Repository: https://github.com/ionos-cloud/sdk-go-bundle.git
Documentation: pkg.go.dev

# README

Go API client for compute

IONOS Enterprise-grade Infrastructure as a Service (IaaS) solutions can be managed through the Cloud API, in addition or as an alternative to the "Data Center Designer" (DCD) browser-based tool.

Both methods employ consistent concepts and features, deliver similar power and flexibility, and can be used to perform a multitude of management tasks, including adding servers, volumes, configuring networks, and so on.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 6.0
  • Package version: products/compute/v0.1.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./compute"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.ionos.com/cloudapi/v6

ClassMethodHTTP requestDescription
DefaultApiApiInfoGetGet /Display API information
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersDeleteDelete /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}Delete Application Load Balancers
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersFindByApplicationLoadBalancerIdGet /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}Retrieve Application Load Balancers
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersFlowlogsDeleteDelete /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}Delete ALB Flow Logs
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersFlowlogsFindByFlowLogIdGet /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}Retrieve ALB Flow Logs
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersFlowlogsGetGet /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogsList ALB Flow Logs
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersFlowlogsPatchPatch /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}Partially modify ALB Flow Logs
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersFlowlogsPostPost /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogsCreate ALB Flow Logs
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersFlowlogsPutPut /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/flowlogs/{flowLogId}Modify ALB Flow Logs
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersForwardingrulesDeleteDelete /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}Delete ALB forwarding rules
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersForwardingrulesFindByForwardingRuleIdGet /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}Retrieve ALB forwarding rules
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersForwardingrulesGetGet /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrulesList ALB forwarding rules
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersForwardingrulesPatchPatch /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}Partially modify ALB forwarding rules
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersForwardingrulesPostPost /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrulesCreate ALB forwarding rules
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersForwardingrulesPutPut /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}/forwardingrules/{forwardingRuleId}Modify ALB forwarding rules
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersGetGet /datacenters/{datacenterId}/applicationloadbalancersList Application Load Balancers
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersPatchPatch /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}Partially modify Application Load Balancers
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersPostPost /datacenters/{datacenterId}/applicationloadbalancersCreate Application Load Balancers
ApplicationLoadBalancersApiDatacentersApplicationloadbalancersPutPut /datacenters/{datacenterId}/applicationloadbalancers/{applicationLoadBalancerId}Modify Application Load Balancers
BackupUnitsApiBackupunitsDeleteDelete /backupunits/{backupunitId}Delete backup units
BackupUnitsApiBackupunitsFindByIdGet /backupunits/{backupunitId}Retrieve backup units
BackupUnitsApiBackupunitsGetGet /backupunitsList backup units
BackupUnitsApiBackupunitsPatchPatch /backupunits/{backupunitId}Partially modify backup units
BackupUnitsApiBackupunitsPostPost /backupunitsCreate backup units
BackupUnitsApiBackupunitsPutPut /backupunits/{backupunitId}Modify backup units
BackupUnitsApiBackupunitsSsourlGetGet /backupunits/{backupunitId}/ssourlRetrieve BU single sign-on URLs
ContractResourcesApiContractsGetGet /contractsRetrieve contracts
DataCentersApiDatacentersDeleteDelete /datacenters/{datacenterId}Delete data centers
DataCentersApiDatacentersFindByIdGet /datacenters/{datacenterId}Retrieve data centers
DataCentersApiDatacentersGetGet /datacentersList your data centers
DataCentersApiDatacentersPatchPatch /datacenters/{datacenterId}Partially modify data centers
DataCentersApiDatacentersPostPost /datacentersCreate data centers
DataCentersApiDatacentersPutPut /datacenters/{datacenterId}Modify data centers
FirewallRulesApiDatacentersServersNicsFirewallrulesDeleteDelete /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}Delete firewall rules
FirewallRulesApiDatacentersServersNicsFirewallrulesFindByIdGet /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}Retrieve firewall rules
FirewallRulesApiDatacentersServersNicsFirewallrulesGetGet /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrulesList firewall rules
FirewallRulesApiDatacentersServersNicsFirewallrulesPatchPatch /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}Partially modify firewall rules
FirewallRulesApiDatacentersServersNicsFirewallrulesPostPost /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrulesCreate firewall rules
FirewallRulesApiDatacentersServersNicsFirewallrulesPutPut /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/firewallrules/{firewallruleId}Modify firewall rules
FlowLogsApiDatacentersServersNicsFlowlogsDeleteDelete /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}Delete Flow Logs
FlowLogsApiDatacentersServersNicsFlowlogsFindByIdGet /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}Retrieve Flow Logs
FlowLogsApiDatacentersServersNicsFlowlogsGetGet /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogsList Flow Logs
FlowLogsApiDatacentersServersNicsFlowlogsPatchPatch /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}Partially modify Flow Logs
FlowLogsApiDatacentersServersNicsFlowlogsPostPost /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogsCreate Flow Logs
FlowLogsApiDatacentersServersNicsFlowlogsPutPut /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}/flowlogs/{flowlogId}Modify Flow Logs
IPBlocksApiIpblocksDeleteDelete /ipblocks/{ipblockId}Delete IP blocks
IPBlocksApiIpblocksFindByIdGet /ipblocks/{ipblockId}Retrieve IP blocks
IPBlocksApiIpblocksGetGet /ipblocksList IP blocks
IPBlocksApiIpblocksPatchPatch /ipblocks/{ipblockId}Partially modify IP blocks
IPBlocksApiIpblocksPostPost /ipblocksReserve IP blocks
IPBlocksApiIpblocksPutPut /ipblocks/{ipblockId}Modify IP blocks
ImagesApiImagesDeleteDelete /images/{imageId}Delete images
ImagesApiImagesFindByIdGet /images/{imageId}Retrieve images
ImagesApiImagesGetGet /imagesList images
ImagesApiImagesPatchPatch /images/{imageId}Partially modify images
ImagesApiImagesPutPut /images/{imageId}Modify images
KubernetesApiK8sDeleteDelete /k8s/{k8sClusterId}Delete Kubernetes clusters
KubernetesApiK8sFindByClusterIdGet /k8s/{k8sClusterId}Retrieve Kubernetes clusters
KubernetesApiK8sGetGet /k8sList Kubernetes clusters
KubernetesApiK8sKubeconfigGetGet /k8s/{k8sClusterId}/kubeconfigRetrieve Kubernetes configuration files
KubernetesApiK8sNodepoolsDeleteDelete /k8s/{k8sClusterId}/nodepools/{nodepoolId}Delete Kubernetes node pools
KubernetesApiK8sNodepoolsFindByIdGet /k8s/{k8sClusterId}/nodepools/{nodepoolId}Retrieve Kubernetes node pools
KubernetesApiK8sNodepoolsGetGet /k8s/{k8sClusterId}/nodepoolsList Kubernetes node pools
KubernetesApiK8sNodepoolsNodesDeleteDelete /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}Delete Kubernetes nodes
KubernetesApiK8sNodepoolsNodesFindByIdGet /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}Retrieve Kubernetes nodes
KubernetesApiK8sNodepoolsNodesGetGet /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodesList Kubernetes nodes
KubernetesApiK8sNodepoolsNodesReplacePostPost /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replaceRecreate Kubernetes nodes
KubernetesApiK8sNodepoolsPostPost /k8s/{k8sClusterId}/nodepoolsCreate Kubernetes node pools
KubernetesApiK8sNodepoolsPutPut /k8s/{k8sClusterId}/nodepools/{nodepoolId}Modify Kubernetes node pools
KubernetesApiK8sPostPost /k8sCreate Kubernetes clusters
KubernetesApiK8sPutPut /k8s/{k8sClusterId}Modify Kubernetes clusters
KubernetesApiK8sVersionsDefaultGetGet /k8s/versions/defaultRetrieve current default Kubernetes version
KubernetesApiK8sVersionsGetGet /k8s/versionsList Kubernetes versions
LANsApiDatacentersLansDeleteDelete /datacenters/{datacenterId}/lans/{lanId}Delete LANs
LANsApiDatacentersLansFindByIdGet /datacenters/{datacenterId}/lans/{lanId}Retrieve LANs
LANsApiDatacentersLansGetGet /datacenters/{datacenterId}/lansList LANs
LANsApiDatacentersLansNicsFindByIdGet /datacenters/{datacenterId}/lans/{lanId}/nics/{nicId}Retrieve attached NICs
LANsApiDatacentersLansNicsGetGet /datacenters/{datacenterId}/lans/{lanId}/nicsList LAN members
LANsApiDatacentersLansNicsPostPost /datacenters/{datacenterId}/lans/{lanId}/nicsAttach NICs
LANsApiDatacentersLansPatchPatch /datacenters/{datacenterId}/lans/{lanId}Partially modify LANs
LANsApiDatacentersLansPostPost /datacenters/{datacenterId}/lansCreate LANs
LANsApiDatacentersLansPutPut /datacenters/{datacenterId}/lans/{lanId}Modify LANs
LabelsApiDatacentersLabelsDeleteDelete /datacenters/{datacenterId}/labels/{key}Delete data center labels
LabelsApiDatacentersLabelsFindByKeyGet /datacenters/{datacenterId}/labels/{key}Retrieve data center labels
LabelsApiDatacentersLabelsGetGet /datacenters/{datacenterId}/labelsList data center labels
LabelsApiDatacentersLabelsPostPost /datacenters/{datacenterId}/labelsCreate data center labels
LabelsApiDatacentersLabelsPutPut /datacenters/{datacenterId}/labels/{key}Modify data center labels
LabelsApiDatacentersServersLabelsDeleteDelete /datacenters/{datacenterId}/servers/{serverId}/labels/{key}Delete server labels
LabelsApiDatacentersServersLabelsFindByKeyGet /datacenters/{datacenterId}/servers/{serverId}/labels/{key}Retrieve server labels
LabelsApiDatacentersServersLabelsGetGet /datacenters/{datacenterId}/servers/{serverId}/labelsList server labels
LabelsApiDatacentersServersLabelsPostPost /datacenters/{datacenterId}/servers/{serverId}/labelsCreate server labels
LabelsApiDatacentersServersLabelsPutPut /datacenters/{datacenterId}/servers/{serverId}/labels/{key}Modify server labels
LabelsApiDatacentersVolumesLabelsDeleteDelete /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}Delete volume labels
LabelsApiDatacentersVolumesLabelsFindByKeyGet /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}Retrieve volume labels
LabelsApiDatacentersVolumesLabelsGetGet /datacenters/{datacenterId}/volumes/{volumeId}/labelsList volume labels
LabelsApiDatacentersVolumesLabelsPostPost /datacenters/{datacenterId}/volumes/{volumeId}/labelsCreate volume labels
LabelsApiDatacentersVolumesLabelsPutPut /datacenters/{datacenterId}/volumes/{volumeId}/labels/{key}Modify volume labels
LabelsApiIpblocksLabelsDeleteDelete /ipblocks/{ipblockId}/labels/{key}Delete IP block labels
LabelsApiIpblocksLabelsFindByKeyGet /ipblocks/{ipblockId}/labels/{key}Retrieve IP block labels
LabelsApiIpblocksLabelsGetGet /ipblocks/{ipblockId}/labelsList IP block labels
LabelsApiIpblocksLabelsPostPost /ipblocks/{ipblockId}/labelsCreate IP block labels
LabelsApiIpblocksLabelsPutPut /ipblocks/{ipblockId}/labels/{key}Modify IP block labels
LabelsApiLabelsFindByUrnGet /labels/{labelurn}Retrieve labels by URN
LabelsApiLabelsGetGet /labelsList labels
LabelsApiSnapshotsLabelsDeleteDelete /snapshots/{snapshotId}/labels/{key}Delete snapshot labels
LabelsApiSnapshotsLabelsFindByKeyGet /snapshots/{snapshotId}/labels/{key}Retrieve snapshot labels
LabelsApiSnapshotsLabelsGetGet /snapshots/{snapshotId}/labelsList snapshot labels
LabelsApiSnapshotsLabelsPostPost /snapshots/{snapshotId}/labelsCreate snapshot labels
LabelsApiSnapshotsLabelsPutPut /snapshots/{snapshotId}/labels/{key}Modify snapshot labels
LoadBalancersApiDatacentersLoadbalancersBalancednicsDeleteDelete /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}Detach balanced NICs
LoadBalancersApiDatacentersLoadbalancersBalancednicsFindByNicIdGet /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednics/{nicId}Retrieve balanced NICs
LoadBalancersApiDatacentersLoadbalancersBalancednicsGetGet /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednicsList balanced NICs
LoadBalancersApiDatacentersLoadbalancersBalancednicsPostPost /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}/balancednicsAttach balanced NICs
LoadBalancersApiDatacentersLoadbalancersDeleteDelete /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}Delete Load Balancers
LoadBalancersApiDatacentersLoadbalancersFindByIdGet /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}Retrieve Load Balancers
LoadBalancersApiDatacentersLoadbalancersGetGet /datacenters/{datacenterId}/loadbalancersList Load Balancers
LoadBalancersApiDatacentersLoadbalancersPatchPatch /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}Partially modify Load Balancers
LoadBalancersApiDatacentersLoadbalancersPostPost /datacenters/{datacenterId}/loadbalancersCreate Load Balancers
LoadBalancersApiDatacentersLoadbalancersPutPut /datacenters/{datacenterId}/loadbalancers/{loadbalancerId}Modify Load Balancers
LocationsApiLocationsFindByRegionIdGet /locations/{regionId}List locations within regions
LocationsApiLocationsFindByRegionIdAndIdGet /locations/{regionId}/{locationId}Retrieve specified locations
LocationsApiLocationsGetGet /locationsList locations
NATGatewaysApiDatacentersNatgatewaysDeleteDelete /datacenters/{datacenterId}/natgateways/{natGatewayId}Delete NAT Gateways
NATGatewaysApiDatacentersNatgatewaysFindByNatGatewayIdGet /datacenters/{datacenterId}/natgateways/{natGatewayId}Retrieve NAT Gateways
NATGatewaysApiDatacentersNatgatewaysFlowlogsDeleteDelete /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}Delete NAT Gateway Flow Logs
NATGatewaysApiDatacentersNatgatewaysFlowlogsFindByFlowLogIdGet /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}Retrieve NAT Gateway Flow Logs
NATGatewaysApiDatacentersNatgatewaysFlowlogsGetGet /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogsList NAT Gateway Flow Logs
NATGatewaysApiDatacentersNatgatewaysFlowlogsPatchPatch /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}Partially modify NAT Gateway Flow Logs
NATGatewaysApiDatacentersNatgatewaysFlowlogsPostPost /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogsCreate NAT Gateway Flow Logs
NATGatewaysApiDatacentersNatgatewaysFlowlogsPutPut /datacenters/{datacenterId}/natgateways/{natGatewayId}/flowlogs/{flowLogId}Modify NAT Gateway Flow Logs
NATGatewaysApiDatacentersNatgatewaysGetGet /datacenters/{datacenterId}/natgatewaysList NAT Gateways
NATGatewaysApiDatacentersNatgatewaysPatchPatch /datacenters/{datacenterId}/natgateways/{natGatewayId}Partially modify NAT Gateways
NATGatewaysApiDatacentersNatgatewaysPostPost /datacenters/{datacenterId}/natgatewaysCreate NAT Gateways
NATGatewaysApiDatacentersNatgatewaysPutPut /datacenters/{datacenterId}/natgateways/{natGatewayId}Modify NAT Gateways
NATGatewaysApiDatacentersNatgatewaysRulesDeleteDelete /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}Delete NAT Gateway rules
NATGatewaysApiDatacentersNatgatewaysRulesFindByNatGatewayRuleIdGet /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}Retrieve NAT Gateway rules
NATGatewaysApiDatacentersNatgatewaysRulesGetGet /datacenters/{datacenterId}/natgateways/{natGatewayId}/rulesList NAT Gateway rules
NATGatewaysApiDatacentersNatgatewaysRulesPatchPatch /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}Partially modify NAT Gateway rules
NATGatewaysApiDatacentersNatgatewaysRulesPostPost /datacenters/{datacenterId}/natgateways/{natGatewayId}/rulesCreate NAT Gateway rules
NATGatewaysApiDatacentersNatgatewaysRulesPutPut /datacenters/{datacenterId}/natgateways/{natGatewayId}/rules/{natGatewayRuleId}Modify NAT Gateway rules
NetworkInterfacesApiDatacentersServersNicsDeleteDelete /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}Delete NICs
NetworkInterfacesApiDatacentersServersNicsFindByIdGet /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}Retrieve NICs
NetworkInterfacesApiDatacentersServersNicsGetGet /datacenters/{datacenterId}/servers/{serverId}/nicsList NICs
NetworkInterfacesApiDatacentersServersNicsPatchPatch /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}Partially modify NICs
NetworkInterfacesApiDatacentersServersNicsPostPost /datacenters/{datacenterId}/servers/{serverId}/nicsCreate NICs
NetworkInterfacesApiDatacentersServersNicsPutPut /datacenters/{datacenterId}/servers/{serverId}/nics/{nicId}Modify NICs
NetworkLoadBalancersApiDatacentersNetworkloadbalancersDeleteDelete /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}Delete Network Load Balancers
NetworkLoadBalancersApiDatacentersNetworkloadbalancersFindByNetworkLoadBalancerIdGet /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}Retrieve Network Load Balancers
NetworkLoadBalancersApiDatacentersNetworkloadbalancersFlowlogsDeleteDelete /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}Delete NLB Flow Logs
NetworkLoadBalancersApiDatacentersNetworkloadbalancersFlowlogsFindByFlowLogIdGet /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}Retrieve NLB Flow Logs
NetworkLoadBalancersApiDatacentersNetworkloadbalancersFlowlogsGetGet /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogsList NLB Flow Logs
NetworkLoadBalancersApiDatacentersNetworkloadbalancersFlowlogsPatchPatch /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}Partially modify NLB Flow Logs
NetworkLoadBalancersApiDatacentersNetworkloadbalancersFlowlogsPostPost /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogsCreate NLB Flow Logs
NetworkLoadBalancersApiDatacentersNetworkloadbalancersFlowlogsPutPut /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/flowlogs/{flowLogId}Modify NLB Flow Logs
NetworkLoadBalancersApiDatacentersNetworkloadbalancersForwardingrulesDeleteDelete /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}Delete NLB forwarding rules
NetworkLoadBalancersApiDatacentersNetworkloadbalancersForwardingrulesFindByForwardingRuleIdGet /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}Retrieve NLB forwarding rules
NetworkLoadBalancersApiDatacentersNetworkloadbalancersForwardingrulesGetGet /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrulesList NLB forwarding rules
NetworkLoadBalancersApiDatacentersNetworkloadbalancersForwardingrulesPatchPatch /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}Partially modify NLB forwarding rules
NetworkLoadBalancersApiDatacentersNetworkloadbalancersForwardingrulesPostPost /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrulesCreate NLB forwarding rules
NetworkLoadBalancersApiDatacentersNetworkloadbalancersForwardingrulesPutPut /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}/forwardingrules/{forwardingRuleId}Modify NLB forwarding rules
NetworkLoadBalancersApiDatacentersNetworkloadbalancersGetGet /datacenters/{datacenterId}/networkloadbalancersList Network Load Balancers
NetworkLoadBalancersApiDatacentersNetworkloadbalancersPatchPatch /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}Partially modify Network Load Balancers
NetworkLoadBalancersApiDatacentersNetworkloadbalancersPostPost /datacenters/{datacenterId}/networkloadbalancersCreate Network Load Balancers
NetworkLoadBalancersApiDatacentersNetworkloadbalancersPutPut /datacenters/{datacenterId}/networkloadbalancers/{networkLoadBalancerId}Modify Network Load Balancers
PrivateCrossConnectsApiPccsDeleteDelete /pccs/{pccId}Delete private Cross-Connects
PrivateCrossConnectsApiPccsFindByIdGet /pccs/{pccId}Retrieve private Cross-Connects
PrivateCrossConnectsApiPccsGetGet /pccsList private Cross-Connects
PrivateCrossConnectsApiPccsPatchPatch /pccs/{pccId}Partially modify private Cross-Connects
PrivateCrossConnectsApiPccsPostPost /pccsCreate private Cross-Connects
RequestsApiRequestsFindByIdGet /requests/{requestId}Retrieve requests
RequestsApiRequestsGetGet /requestsList requests
RequestsApiRequestsStatusGetGet /requests/{requestId}/statusRetrieve request status
ServersApiDatacentersServersCdromsDeleteDelete /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}Detach CD-ROMs
ServersApiDatacentersServersCdromsFindByIdGet /datacenters/{datacenterId}/servers/{serverId}/cdroms/{cdromId}Retrieve attached CD-ROMs
ServersApiDatacentersServersCdromsGetGet /datacenters/{datacenterId}/servers/{serverId}/cdromsList attached CD-ROMs
ServersApiDatacentersServersCdromsPostPost /datacenters/{datacenterId}/servers/{serverId}/cdromsAttach CD-ROMs
ServersApiDatacentersServersDeleteDelete /datacenters/{datacenterId}/servers/{serverId}Delete servers
ServersApiDatacentersServersFindByIdGet /datacenters/{datacenterId}/servers/{serverId}Retrieve servers by ID
ServersApiDatacentersServersGetGet /datacenters/{datacenterId}/serversList servers
ServersApiDatacentersServersPatchPatch /datacenters/{datacenterId}/servers/{serverId}Partially modify servers
ServersApiDatacentersServersPostPost /datacenters/{datacenterId}/serversCreate servers
ServersApiDatacentersServersPutPut /datacenters/{datacenterId}/servers/{serverId}Modify servers
ServersApiDatacentersServersRebootPostPost /datacenters/{datacenterId}/servers/{serverId}/rebootReboot servers
ServersApiDatacentersServersRemoteConsoleGetGet /datacenters/{datacenterId}/servers/{serverId}/remoteconsoleGet Remote Console link
ServersApiDatacentersServersResumePostPost /datacenters/{datacenterId}/servers/{serverId}/resumeResume Cubes instances
ServersApiDatacentersServersStartPostPost /datacenters/{datacenterId}/servers/{serverId}/startStart servers
ServersApiDatacentersServersStopPostPost /datacenters/{datacenterId}/servers/{serverId}/stopStop VMs
ServersApiDatacentersServersSuspendPostPost /datacenters/{datacenterId}/servers/{serverId}/suspendSuspend Cubes instances
ServersApiDatacentersServersTokenGetGet /datacenters/{datacenterId}/servers/{serverId}/tokenGet JASON Web Token
ServersApiDatacentersServersUpgradePostPost /datacenters/{datacenterId}/servers/{serverId}/upgradeUpgrade servers
ServersApiDatacentersServersVolumesDeleteDelete /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}Detach volumes
ServersApiDatacentersServersVolumesFindByIdGet /datacenters/{datacenterId}/servers/{serverId}/volumes/{volumeId}Retrieve attached volumes
ServersApiDatacentersServersVolumesGetGet /datacenters/{datacenterId}/servers/{serverId}/volumesList attached volumes
ServersApiDatacentersServersVolumesPostPost /datacenters/{datacenterId}/servers/{serverId}/volumesAttach volumes
SnapshotsApiSnapshotsDeleteDelete /snapshots/{snapshotId}Delete snapshots
SnapshotsApiSnapshotsFindByIdGet /snapshots/{snapshotId}Retrieve snapshots by ID
SnapshotsApiSnapshotsGetGet /snapshotsList snapshots
SnapshotsApiSnapshotsPatchPatch /snapshots/{snapshotId}Partially modify snapshots
SnapshotsApiSnapshotsPutPut /snapshots/{snapshotId}Modify snapshots
TargetGroupsApiTargetGroupsDeleteDelete /targetgroups/{targetGroupId}Remove target groups
TargetGroupsApiTargetgroupsFindByTargetGroupIdGet /targetgroups/{targetGroupId}Retrieve target groups
TargetGroupsApiTargetgroupsGetGet /targetgroupsList target groups
TargetGroupsApiTargetgroupsPatchPatch /targetgroups/{targetGroupId}Partially modify target groups
TargetGroupsApiTargetgroupsPostPost /targetgroupsCreate target groups
TargetGroupsApiTargetgroupsPutPut /targetgroups/{targetGroupId}Modify target groups
TemplatesApiTemplatesFindByIdGet /templates/{templateId}Retrieve Cubes Templates
TemplatesApiTemplatesGetGet /templatesList Cubes Templates
UserManagementApiUmGroupsDeleteDelete /um/groups/{groupId}Delete groups
UserManagementApiUmGroupsFindByIdGet /um/groups/{groupId}Retrieve groups
UserManagementApiUmGroupsGetGet /um/groupsList all groups
UserManagementApiUmGroupsPostPost /um/groupsCreate groups
UserManagementApiUmGroupsPutPut /um/groups/{groupId}Modify groups
UserManagementApiUmGroupsResourcesGetGet /um/groups/{groupId}/resourcesRetrieve group resources
UserManagementApiUmGroupsSharesDeleteDelete /um/groups/{groupId}/shares/{resourceId}Remove group shares
UserManagementApiUmGroupsSharesFindByResourceIdGet /um/groups/{groupId}/shares/{resourceId}Retrieve group shares
UserManagementApiUmGroupsSharesGetGet /um/groups/{groupId}/sharesList group shares
UserManagementApiUmGroupsSharesPostPost /um/groups/{groupId}/shares/{resourceId}Add group shares
UserManagementApiUmGroupsSharesPutPut /um/groups/{groupId}/shares/{resourceId}Modify group share privileges
UserManagementApiUmGroupsUsersDeleteDelete /um/groups/{groupId}/users/{userId}Remove users from groups
UserManagementApiUmGroupsUsersGetGet /um/groups/{groupId}/usersList group members
UserManagementApiUmGroupsUsersPostPost /um/groups/{groupId}/usersAdd group members
UserManagementApiUmResourcesFindByTypeGet /um/resources/{resourceType}List resources by type
UserManagementApiUmResourcesFindByTypeAndIdGet /um/resources/{resourceType}/{resourceId}Retrieve resources by type
UserManagementApiUmResourcesGetGet /um/resourcesList all resources
UserManagementApiUmUsersDeleteDelete /um/users/{userId}Delete users
UserManagementApiUmUsersFindByIdGet /um/users/{userId}Retrieve users
UserManagementApiUmUsersGetGet /um/usersList all users
UserManagementApiUmUsersGroupsGetGet /um/users/{userId}/groupsRetrieve group resources by user ID
UserManagementApiUmUsersOwnsGetGet /um/users/{userId}/ownsRetrieve user resources by user ID
UserManagementApiUmUsersPostPost /um/usersCreate users
UserManagementApiUmUsersPutPut /um/users/{userId}Modify users
UserS3KeysApiUmUsersS3keysDeleteDelete /um/users/{userId}/s3keys/{keyId}Delete S3 keys
UserS3KeysApiUmUsersS3keysFindByKeyIdGet /um/users/{userId}/s3keys/{keyId}Retrieve user S3 keys by key ID
UserS3KeysApiUmUsersS3keysGetGet /um/users/{userId}/s3keysList user S3 keys
UserS3KeysApiUmUsersS3keysPostPost /um/users/{userId}/s3keysCreate user S3 keys
UserS3KeysApiUmUsersS3keysPutPut /um/users/{userId}/s3keys/{keyId}Modify S3 keys by key ID
UserS3KeysApiUmUsersS3ssourlGetGet /um/users/{userId}/s3ssourlRetrieve S3 single sign-on URLs
VolumesApiDatacentersVolumesCreateSnapshotPostPost /datacenters/{datacenterId}/volumes/{volumeId}/create-snapshotCreate volume snapshots
VolumesApiDatacentersVolumesDeleteDelete /datacenters/{datacenterId}/volumes/{volumeId}Delete volumes
VolumesApiDatacentersVolumesFindByIdGet /datacenters/{datacenterId}/volumes/{volumeId}Retrieve volumes
VolumesApiDatacentersVolumesGetGet /datacenters/{datacenterId}/volumesList volumes
VolumesApiDatacentersVolumesPatchPatch /datacenters/{datacenterId}/volumes/{volumeId}Partially modify volumes
VolumesApiDatacentersVolumesPostPost /datacenters/{datacenterId}/volumesCreate volumes
VolumesApiDatacentersVolumesPutPut /datacenters/{datacenterId}/volumes/{volumeId}Modify volumes
VolumesApiDatacentersVolumesRestoreSnapshotPostPost /datacenters/{datacenterId}/volumes/{volumeId}/restore-snapshotRestore volume snapshots

Documentation For Models

Documentation For Authorization

Basic Authentication

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Token Authentication

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author