Package: ionoscloud-vm-autoscaling
Python API client for ionoscloud_vm_autoscalingThe 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.OverviewThe IONOS Cloud SDK for Python provides you with access to the IONOS Cloud API. The client library supports both simple and complex requests. It is designed for developers who are building applications in Python. All API operations are performed over SSL and authenticated using your IONOS Cloud portal credentials. The API can be accessed within an instance running in IONOS Cloud or directly over the Internet from any application that can send an HTTPS request and receive an HTTPS response.Installation & UsageRequirements:Python >= 3.5pip installSince this package is hosted onPypiyou can install it by using:pipinstallionoscloud-vm-autoscalingIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/ionos-cloud/sdk-python-vm-autoscaling.gitNote: you may need to runpipwith root permission:sudo pip install git+https://github.com/ionos-cloud/sdk-python-vm-autoscaling.gitThen import the package:importionoscloud_vm_autoscalingSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--userorsudo python setup.py installto install the package for all usersThen import the package:importionoscloud_vm_autoscalingNOTE:The Python SDK does not support Python 2. It only supports Python >= 3.5.AuthenticationThe username and passwordorthe authentication token can be manually specified when initializing the SDK client:configuration=ionoscloud_vm_autoscaling.Configuration(username='YOUR_USERNAME',password='YOUR_PASSWORD',token='YOUR_TOKEN')client=ionoscloud_vm_autoscaling.ApiClient(configuration)Environment variables can also be used. This is an example of how one would do that:importosconfiguration=ionoscloud_vm_autoscaling.Configuration(username=os.environ.get('IONOS_USERNAME'),password=os.environ.get('IONOS_PASSWORD'),token=os.environ.get('IONOS_TOKEN'))client=ionoscloud_vm_autoscaling.ApiClient(configuration)Warning: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.HTTP proxiesYou can use http proxies by setting the following environment variables:IONOS_HTTP_PROXY- proxy URLIONOS_HTTP_PROXY_HEADERS- proxy headersEach line inIONOS_HTTP_PROXY_HEADERSrepresents one header, where the header name and value is separated by a colon. Newline characters within a value need to be escaped. See this example:Connection: Keep-Alive
User-Info: MyID
User-Group: my long\nheader valueChanging the base URLBase URL for the HTTP operation can be changed in the following way:importosconfiguration=ionoscloud_vm_autoscaling.Configuration(username=os.environ.get('IONOS_USERNAME'),password=os.environ.get('IONOS_PASSWORD'),host=os.environ.get('IONOS_API_URL'),server_index=None,)client=ionoscloud_vm_autoscaling.ApiClient(configuration)Certificate pinning:You can enable certificate pinning if you want to bypass the normal certificate checking procedure,
by doing the following:Set env variable IONOS_PINNED_CERT=<insert_sha256_public_fingerprint_here>You can get the sha256 fingerprint most easily from the browser by inspecting the certificate.Documentation for API EndpointsAll URIs are relative tohttps://api.ionos.com/autoscalingAPI Endpoints tableClassMethodHTTP requestDescriptionAutoScalingGroupsApigroups_actions_find_by_idGET/groups/{groupId}/actions/{actionId}Get Scaling Action Details by IDAutoScalingGroupsApigroups_actions_getGET/groups/{groupId}/actionsGet Scaling ActionsAutoScalingGroupsApigroups_deleteDELETE/groups/{groupId}Delete a VM Auto Scaling Group by IDAutoScalingGroupsApigroups_find_by_idGET/groups/{groupId}Get an Auto Scaling by IDAutoScalingGroupsApigroups_getGET/groupsGet VM Auto Scaling GroupsAutoScalingGroupsApigroups_postPOST/groupsCreate a VM Auto Scaling GroupAutoScalingGroupsApigroups_putPUT/groups/{groupId}Update a VM Auto Scaling Group by IDAutoScalingGroupsApigroups_servers_find_by_idGET/groups/{groupId}/servers/{serverId}Get VM Auto Scaling Group Server by IDAutoScalingGroupsApigroups_servers_getGET/groups/{groupId}/serversGet VM Auto Scaling Group ServersDocumentation For ModelsAll URIs are relative tohttps://api.ionos.com/autoscalingAPI models listActionActionAmountActionCollectionActionPropertiesActionResourceActionStatusActionTypeActionsLinkResourceAvailabilityZoneBusTypeCpuFamilyDatacenterServerError401Error401MessageError404Error404MessageErrorAuthorizeErrorAuthorizeMessageErrorGroupValidateErrorGroupValidateMessageErrorMessageErrorMessageParseGroupGroupCollectionGroupEntitiesGroupPolicyGroupPolicyScaleInActionGroupPolicyScaleOutActionGroupPostGroupPostEntitiesGroupPostResponseGroupPropertiesGroupPropertiesDatacenterGroupPutGroupPutPropertiesGroupPutPropertiesDatacenterGroupResourceMetadataMetadataBasicMetadataStateMetricNicFirewallRuleNicFlowLogParseErrorQueryUnitReplicaNicReplicaPropertiesPostReplicaVolumePostServerServerCollectionServerPropertiesServersLinkResourceTargetGroupTerminationPolicyTypeVolumeHwType[Back to API list][Back to Model list]