AutoScalingGroupsApi

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

Method
HTTP request
Description

Get /groups/{groupId}/actions/{actionId}

Get Scaling Action Details by ID

Get /groups/{groupId}/actions

Get Scaling Actions

Delete /groups/{groupId}

Delete a VM Auto Scaling Group by ID

Get /groups/{groupId}

Get an Auto Scaling by ID

Get /groups

Get VM Auto Scaling Groups

Post /groups

Create a VM Auto Scaling Group

Put /groups/{groupId}

Update a VM Auto Scaling Group by ID

Get /groups/{groupId}/servers/{serverId}

Get VM Auto Scaling Group Server by ID

Get /groups/{groupId}/servers

Get VM Auto Scaling Group Servers

GroupsActionsFindById

var result Action = GroupsActionsFindById(ctx, actionId, groupId)
                      .Depth(depth)
                      .Execute()

Get Scaling Action Details by ID

Example

package main

import (
    "context"
    "fmt"
    "os"

    vmautoscaling "github.com/ionos-cloud/sdk-go-bundle/products/vmautoscaling"
    "github.com/ionos-cloud/sdk-go-bundle/shared"
)

func main() {
    actionId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    groupId := "groupId_example" // string | 
    depth := float32(8.14) // float32 | With this parameter, you control the level of detail of the response objects:    - ``0``: Only direct properties are included; children (such as executions or transitions) are not considered.    - ``1``: Direct properties and children references are included.    - ``2``: Direct properties and children properties are included.    - ``3``: Direct properties and children properties and children's children are included.    - etc.   (optional) (default to 0)

    configuration := shared.NewConfiguration("USERNAME", "PASSWORD", "TOKEN", "HOST_URL")
    apiClient := vmautoscaling.NewAPIClient(configuration)
    resource, resp, err := apiClient.AutoScalingGroupsApi.GroupsActionsFindById(context.Background(), actionId, groupId).Depth(depth).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AutoScalingGroupsApi.GroupsActionsFindById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", resp)
    }
    // response from `GroupsActionsFindById`: Action
    fmt.Fprintf(os.Stdout, "Response from `AutoScalingGroupsApi.GroupsActionsFindById`: %v\n", resource)
}

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

actionId

string

groupId

string

Other Parameters

Other parameters are passed through a pointer to an apiGroupsActionsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

depth

float32

With this parameter, you control the level of detail of the response objects: - ``0``: Only direct properties are included; children (such as executions or transitions) are not considered. - ``1``: Direct properties and children references are included. - ``2``: Direct properties and children properties are included. - ``3``: Direct properties and children properties and children's children are included. - etc.

[default to 0]

Return type

Action

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

GroupsActionsGet

Get Scaling Actions

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

Other Parameters

Other parameters are passed through a pointer to an apiGroupsActionsGetRequest struct via the builder pattern

Name
Type
Description
Notes

depth

float32

With this parameter, you control the level of detail of the response objects: - ``0``: Only direct properties are included; children (such as executions or transitions) are not considered. - ``1``: Direct properties and children references are included. - ``2``: Direct properties and children properties are included. - ``3``: Direct properties and children properties and children's children are included. - etc.

[default to 0]

orderBy

string

Use this parameter to specify by which the returned list should be sorted. Valid values are: ``createdDate`` and ``lastModifiedDate``.

[default to "createdDate"]

Return type

ActionCollection

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

GroupsDelete

Delete a VM Auto Scaling Group by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

Other Parameters

Other parameters are passed through a pointer to an apiGroupsDeleteRequest struct via the builder pattern

Name

Type

Description

Notes

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

GroupsFindById

Get an Auto Scaling by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

Other Parameters

Other parameters are passed through a pointer to an apiGroupsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

depth

float32

With this parameter, you control the level of detail of the response objects: - ``0``: Only direct properties are included; children (such as executions or transitions) are not considered. - ``1``: Direct properties and children references are included. - ``2``: Direct properties and children properties are included. - ``3``: Direct properties and children properties and children's children are included. - etc.

[default to 0]

Return type

Group

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

GroupsGet

Get VM Auto Scaling Groups

Example

Path Parameters

Other Parameters

Other parameters are passed through a pointer to an apiGroupsGetRequest struct via the builder pattern

Name
Type
Description
Notes

depth

float32

With this parameter, you control the level of detail of the response objects: - ``0``: Only direct properties are included; children (such as executions or transitions) are not considered. - ``1``: Direct properties and children references are included. - ``2``: Direct properties and children properties are included. - ``3``: Direct properties and children properties and children's children are included. - etc.

[default to 0]

orderBy

string

Use this parameter to specify by which the returned list should be sorted. Valid values are: ``createdDate`` and ``lastModifiedDate``.

[default to "createdDate"]

Return type

GroupCollection

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

GroupsPost

Create a VM Auto Scaling Group

Example

Path Parameters

Other Parameters

Other parameters are passed through a pointer to an apiGroupsPostRequest struct via the builder pattern

Name
Type
Description
Notes

groupPost

Return type

GroupPostResponse

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

GroupsPut

Update a VM Auto Scaling Group by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

Other Parameters

Other parameters are passed through a pointer to an apiGroupsPutRequest struct via the builder pattern

Name
Type
Description
Notes

groupPut

Return type

Group

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

GroupsServersFindById

Get VM Auto Scaling Group Server by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

serverId

string

Other Parameters

Other parameters are passed through a pointer to an apiGroupsServersFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

depth

float32

With this parameter, you control the level of detail of the response objects: - ``0``: Only direct properties are included; children (such as executions or transitions) are not considered. - ``1``: Direct properties and children references are included. - ``2``: Direct properties and children properties are included. - ``3``: Direct properties and children properties and children's children are included. - etc.

[default to 0]

Return type

Server

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

GroupsServersGet

Get VM Auto Scaling Group Servers

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

groupId

string

Other Parameters

Other parameters are passed through a pointer to an apiGroupsServersGetRequest struct via the builder pattern

Name
Type
Description
Notes

depth

float32

With this parameter, you control the level of detail of the response objects: - ``0``: Only direct properties are included; children (such as executions or transitions) are not considered. - ``1``: Direct properties and children references are included. - ``2``: Direct properties and children properties are included. - ``3``: Direct properties and children properties and children's children are included. - etc.

[default to 0]

orderBy

string

Use this parameter to specify by which the returned list should be sorted. Valid values are: ``createdDate`` and ``lastModifiedDate``.

[default to "createdDate"]

Return type

ServerCollection

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

Last updated