Welcome to the SaladCloudImdsSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudImdsSdk SDK in your project.
- API version:
0.9.0-alpha.1 - SDK version:
0.9.0-alpha.4
The SaladCloud Instance Metadata Service (IMDS). Please refer to the SaladCloud API Documentation for more details.
This SDK is compatible with the following versions: Python >= 3.7
To get started with the SDK, we recommend installing using pip:
pip install salad-cloud-imds-sdkYou can set a custom timeout for the SDK's HTTP requests as follows:
from salad_cloud_imds_sdk import SaladCloudImdsSdk
sdk = SaladCloudImdsSdk(timeout=10000)Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
from salad_cloud_imds_sdk import SaladCloudImdsSdk, Environment
sdk = SaladCloudImdsSdk(
base_url=Environment.DEFAULT.value,
timeout=10000
)
result = sdk.metadata.get_container_status()
print(result)The SDK provides various services to interact with the API.
Below is a list of all available services with links to their detailed documentation:
| Name |
|---|
| MetadataService |
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
Below is a list of all available models with links to their detailed documentation:
| Name | Description |
|---|---|
| ReallocateContainer | Represents a request to reallocate a container. |
| ContainerStatus | Represents the health statuses of the running container. |
| ContainerToken | Represents the identity token of the running container. |
This SDK is licensed under the MIT License.
See the LICENSE file for more details.