# README

Go API client for ionoscloud

The VM Auto Scaling Service enables IONOS clients to horizontally scale the number of VM replicas based on configured rules. You can use VM Auto Scaling to ensure that you have a sufficient number of replicas to handle your application loads at all times.

For this purpose, create a VM Auto Scaling Group that contains the server replicas. The VM Auto Scaling Service ensures that the number of replicas in the group is always within the defined limits.

When scaling policies are set, VM Auto Scaling creates or deletes replicas according to the requirements of your applications. For each policy, specified 'scale-in' and 'scale-out' actions are performed when the corresponding thresholds are reached.

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: 1-SDK.1
Package version: 1.1.1
Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://docs.ionos.com/faq/contact

Installation

Install the following dependencies:

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

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

import ionoscloud "github.com/ionos-cloud/sdk-go-vm-autoscaling"

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(), ionoscloud.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(), ionoscloud.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AutoScalingGroupsApi	GroupsActionsFindById	Get /groups/{groupId}/actions/{actionId}	Get Scaling Action Details by ID
AutoScalingGroupsApi	GroupsActionsGet	Get /groups/{groupId}/actions	Get Scaling Actions
AutoScalingGroupsApi	GroupsDelete	Delete /groups/{groupId}	Delete a VM Auto Scaling Group by ID
AutoScalingGroupsApi	GroupsFindById	Get /groups/{groupId}	Get an Auto Scaling by ID
AutoScalingGroupsApi	GroupsGet	Get /groups	Get VM Auto Scaling Groups
AutoScalingGroupsApi	GroupsPost	Post /groups	Create a VM Auto Scaling Group
AutoScalingGroupsApi	GroupsPut	Put /groups/{groupId}	Update a VM Auto Scaling Group by ID
AutoScalingGroupsApi	GroupsServersFindById	Get /groups/{groupId}/servers/{serverId}	Get VM Auto Scaling Group Server by ID
AutoScalingGroupsApi	GroupsServersGet	Get /groups/{groupId}/servers	Get VM Auto Scaling Group Servers

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

tokenAuth

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.

Example

auth := context.WithValue(
		context.Background(),
		sw.ContextAPIKeys,
		map[string]sw.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

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

[email protected]