ionoscloud-dbaas-inmemorydb
IONOS CLOUD Database as a Service (DBaaS) In-Memory DB v2 lets you provision and manage in-memory clusters through a REST API. For product information, see IONOS CLOUD In-Memory DB Guide.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 2.0.0
- Package version: 1.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_inmemorydb
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_inmemorydb
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import ionoscloud_dbaas_inmemorydb
from ionoscloud_dbaas_inmemorydb.rest import ApiException
from pprint import pprint
import os
# Defining the host is optional and defaults to https://in-memory-db.de-fra.ionos.com/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud_dbaas_inmemorydb.Configuration(
host = "https://in-memory-db.de-fra.ionos.com/v2"
)
# 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 Bearer authorization (JWT): tokenAuth
configuration = ionoscloud_dbaas_inmemorydb.Configuration(
token = os.environ["IONOS_TOKEN"]
)
# Enter a context with an instance of the API client
with ionoscloud_dbaas_inmemorydb.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud_dbaas_inmemorydb.ClustersApi(api_client)
cluster_id = 'e69b22a5-8fee-56b1-b6fb-4a07e4205ead' # str | The ID (UUID) of the Cluster.
try:
# Delete Cluster
api_instance.clusters_delete(cluster_id)
except ApiException as e:
print("Exception when calling ClustersApi->clusters_delete: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://in-memory-db.de-fra.ionos.com/v2
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ClustersApi | clusters_delete | DELETE /clusters/{clusterId} | Delete Cluster |
| ClustersApi | clusters_find_by_id | GET /clusters/{clusterId} | Retrieve Cluster |
| ClustersApi | clusters_get | GET /clusters | Retrieve all Clusters |
| ClustersApi | clusters_post | POST /clusters | Create Cluster |
| ClustersApi | clusters_put | PUT /clusters/{clusterId} | Ensure Cluster |
| SnapshotLocationsApi | snapshotlocations_find_by_id | GET /snapshot-locations/{snapshotLocationId} | Retrieve SnapshotLocation |
| SnapshotLocationsApi | snapshotlocations_get | GET /snapshot-locations | Retrieve all SnapshotLocations |
| SnapshotsApi | snapshots_find_by_id | GET /snapshots/{snapshotId} | Retrieve Snapshot |
| SnapshotsApi | snapshots_get | GET /snapshots | Retrieve all Snapshots |
| VersionsApi | versions_find_by_id | GET /versions/{versionId} | Retrieve Version |
| VersionsApi | versions_get | GET /versions | Retrieve all Versions |
Documentation For Models
- Cluster
- ClusterConnection
- ClusterCreate
- ClusterCreateProperties
- ClusterEnsure
- ClusterMetadata
- ClusterRead
- ClusterReadList
- ClusterRestoreFromSnapshot
- ClusterState
- DayOfTheWeek
- Error
- ErrorMessagesInner
- EvictionPolicy
- HashedPassword
- InPlaceRestoreClusterFromSnapshot
- InstanceConfiguration
- Links
- MaintenanceWindow
- Metadata
- Pagination
- PersistenceMode
- RestoreClusterFromSnapshot
- Snapshot
- SnapshotConfiguration
- SnapshotLocation
- SnapshotLocationRead
- SnapshotLocationReadList
- SnapshotRead
- SnapshotReadList
- SupportedVersion
- User
- VersionRead
- VersionReadList
Documentation For Authorization
Authentication schemes defined for the API:
tokenAuth
- Type: Bearer authentication (JWT)
Author
Metadata
Release files for ionoscloud-dbaas-inmemorydb 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ionoscloud_dbaas_inmemorydb-1.0.0.tar.gz | 43.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ionoscloud_dbaas_inmemorydb-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 141.2 kB
Release files / ionoscloud_dbaas_inmemorydb-1.0.0.tar.gz
| Download URL | ionoscloud_dbaas_inmemorydb-1.0.0.tar.gz |
|---|---|
| Size | 43.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a249ab9312e77348c6f352a0595793f3af4a22c10109435689982e33b08b9ca1
|
|
BLAKE2b-256 checksum How to use checksums |
7048b209d7ab5f40d5f5d75c9611960377e9f6f620733399806b34efd9c6884a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
Release files / ionoscloud_dbaas_inmemorydb-1.0.0-py3-none-any.whl
| Download URL | ionoscloud_dbaas_inmemorydb-1.0.0-py3-none-any.whl |
|---|---|
| Size | 97.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1a0fe80e3bc3e8905d164325e7463fc6e337c2a774eef7425cc2aeb1f6f13992
|
|
BLAKE2b-256 checksum How to use checksums |
bc9ddffc4ba74b6c7b1dc6d483b217800ff33dd8721c3ce9dd65b16bff6b7ba6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|