ionoscloud-dbaas-mariadb 2.0.0

IONOS DBaaS MariaDB REST API

ionoscloud-dbaas-mariadb

An enterprise-grade Database is provided as a Service (DBaaS) solution that can be managed through a browser-based "Data Center Designer" (DCD) tool or via an easy to use API.

The API allows you to create additional MariaDB database clusters or modify existing ones. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 2.0.0
• Generator version: 7.13.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/ionos-cloud/sdk-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/ionos-cloud/sdk-python.git)

Then import the package:

import ionoscloud_dbaas_mariadb

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ionoscloud_dbaas_mariadb

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ionoscloud_dbaas_mariadb
from ionoscloud_dbaas_mariadb.rest import ApiException
from pprint import pprint
import os

# Defining the host is optional and defaults to https://mariadb.de-txl.ionos.com
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_dbaas_mariadb.Configuration(
    host = "https://mariadb.de-txl.ionos.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with ionoscloud_dbaas_mariadb.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ionoscloud_dbaas_mariadb.BackupsApi(api_client)
    backup_id = '498ae72f-411f-11eb-9d07-046c59cc737e' # str | The unique ID of the backup.

    try:
        # Fetch backups
        api_response = api_instance.backups_find_by_id(backup_id)
        print("The response of BackupsApi->backups_find_by_id:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BackupsApi->backups_find_by_id: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://mariadb.de-txl.ionos.com

Class	Method	HTTP request	Description
BackupsApi	backups_find_by_id	GET /backups/{backupId}	Fetch backups
BackupsApi	backups_get	GET /backups	List of backups.
BackupsApi	cluster_backups_get	GET /clusters/{clusterId}/backups	List backups of cluster
ClustersApi	clusters_delete	DELETE /clusters/{clusterId}	Delete a cluster
ClustersApi	clusters_find_by_id	GET /clusters/{clusterId}	Fetch a cluster
ClustersApi	clusters_get	GET /clusters	List clusters
ClustersApi	clusters_patch	PATCH /clusters/{clusterId}	Update a cluster
ClustersApi	clusters_post	POST /clusters	Create a cluster
RestoreApi	clusters_restore	POST /clusters/{clusterId}/restore	In-place restore of a cluster.

Documentation For Models

• Backup
• BackupList
• BackupProperties
• BackupResponse
• BaseBackup
• ClusterList
• ClusterMetadata
• ClusterProperties
• ClusterResponse
• ClustersGet400Response
• ClustersGet401Response
• ClustersGet403Response
• ClustersGet404Response
• ClustersGet405Response
• ClustersGet415Response
• ClustersGet422Response
• ClustersGet429Response
• ClustersGet500Response
• ClustersGet503Response
• Connection
• CreateClusterProperties
• CreateClusterRequest
• DBUser
• DayOfTheWeek
• ErrorMessage
• InlineObject
• MaintenanceWindow
• MariadbVersion
• Pagination
• PaginationLinks
• PatchClusterProperties
• PatchClusterRequest
• RestoreRequest
• State

Documentation For Authorization

Authentication schemes defined for the API:

tokenAuth

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

Author