Skip to main content

The SaladCloud Instance Metadata Service (IMDS). Please refer to the [SaladCloud API Documentation](https://docs.salad.com/api-reference) for more details.

Project description

SaladCloudImdsSdk Python SDK 0.9.0-alpha.1

Welcome to the SaladCloudImdsSdk SDK documentation. This guide will help you get started with integrating and using the SaladCloudImdsSdk SDK in your project.

Versions

  • API version: 0.9.0-alpha.1
  • SDK version: 0.9.0-alpha.1

About the API

The SaladCloud Instance Metadata Service (IMDS). Please refer to the SaladCloud API Documentation for more details.

Table of Contents

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install salad-cloud-imds-sdk

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

from salad_cloud_imds_sdk import SaladCloudImdsSdk

sdk = SaladCloudImdsSdk(timeout=10000)

Sample Usage

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)

Services

The SDK provides various services to interact with the API.

Below is a list of all available services:
Name
metadata

Models

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:
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.

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

salad_cloud_imds_sdk-0.9.0a1.tar.gz (21.0 kB view details)

Uploaded Source

Built Distribution

salad_cloud_imds_sdk-0.9.0a1-py3-none-any.whl (30.4 kB view details)

Uploaded Python 3

File details

Details for the file salad_cloud_imds_sdk-0.9.0a1.tar.gz.

File metadata

File hashes

Hashes for salad_cloud_imds_sdk-0.9.0a1.tar.gz
Algorithm Hash digest
SHA256 06829378ca8bc03b60c4773e5cce286fc0da57ff9267b86aa8037a011e2642f1
MD5 e7394ca984130d38f84a7ebb86b7faf4
BLAKE2b-256 8f042c72d26cd128645f256a603322332c1688b08e79aeb756314b0de9833869

See more details on using hashes here.

File details

Details for the file salad_cloud_imds_sdk-0.9.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for salad_cloud_imds_sdk-0.9.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 224435d6d865c367521709f96ba8d8bfa928af45c0ec1a4e45047961d2ca4cbc
MD5 654d624af79b01bf2dc61b042e08eeda
BLAKE2b-256 64e36700d23926f1ac4a64edc67dfaa845c70f764f80d7750b49b892268b670a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page