janus-py-client 1.1.post1

The ESnet Janus container API

janus-py-client

REST endpoints for container provisioning and tuning

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

• API version: 1.1
• Package version: 1.1
• Generator version: 7.22.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

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

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import janus_py_client

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 janus_py_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import janus_py_client
from janus_py_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = janus_py_client.Configuration(
    host = "http://localhost"
)

# 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): jwt
configuration = janus_py_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure HTTP basic authorization: basicAuth
configuration = janus_py_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
with janus_py_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = janus_py_client.AuthApi(api_client)
    resource = 'resource_example' # str | Resource type
    rid = 56 # int | Auth ID
    rname = 'rname_example' # str | Auth name
    auth_request = janus_py_client.AuthRequest() # AuthRequest | 

    try:
        # Delete auth info by ID
        api_response = api_instance.controller_delete_auth_auth_path_resource_int_rid_delete(resource, rid, rname, auth_request)
        print("The response of AuthApi->controller_delete_auth_auth_path_resource_int_rid_delete:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthApi->controller_delete_auth_auth_path_resource_int_rid_delete: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AuthApi	controller_delete_auth_auth_path_resource_int_rid_delete	DELETE /api/janus/controller/auth/{resource}/{rid}	Delete auth info by ID
AuthApi	controller_delete_auth_auth_path_resource_path_rname_delete	DELETE /api/janus/controller/auth/{resource}/{rname}	Delete auth info by name
AuthApi	controller_get_auth_auth_path_resource_get	GET /api/janus/controller/auth/{resource}	Get auth info
AuthApi	controller_get_auth_auth_path_resource_int_rid_get	GET /api/janus/controller/auth/{resource}/{rid}	Get specific auth info by ID
AuthApi	controller_get_auth_auth_path_resource_path_rname_get	GET /api/janus/controller/auth/{resource}/{rname}	Get specific auth info by name
AuthApi	controller_post_auth_auth_path_resource_int_rid_post	POST /api/janus/controller/auth/{resource}/{rid}	Update auth info by ID
AuthApi	controller_post_auth_auth_path_resource_path_rname_post	POST /api/janus/controller/auth/{resource}/{rname}	Update auth info by name
AuthApi	controller_post_auth_bulk_auth_bulk_post	POST /api/janus/controller/auth/bulk	Bulk update auth info
ImagesApi	controller_get_images_images_get	GET /api/janus/controller/images	Get images
ImagesApi	controller_get_images_images_path_name_get	GET /api/janus/controller/images/{name}	Get a specific image
NodesApi	controller_add_node_nodes_post	POST /api/janus/controller/nodes	Add a new node
NodesApi	controller_delete_node_nodes_int_id_delete	DELETE /api/janus/controller/nodes/{id}	Delete node by ID
NodesApi	controller_delete_node_nodes_node_delete	DELETE /api/janus/controller/nodes/{node}	Delete node by name
NodesApi	controller_get_node_by_id_or_name_nodes_int_id_get	GET /api/janus/controller/nodes/{id}	Get node by ID
NodesApi	controller_get_node_by_id_or_name_nodes_node_get	GET /api/janus/controller/nodes/{node}	Get node by name
NodesApi	controller_get_nodes_nodes_get	GET /api/janus/controller/nodes	Get nodes
ProfilesApi	controller_delete_profile_profiles_path_resource_path_rname_delete	DELETE /api/janus/controller/profiles/{resource}/{rname}	Remove a profile
ProfilesApi	controller_get_profile_by_name_profiles_path_resource_path_rname_get	GET /api/janus/controller/profiles/{resource}/{rname}	Get a specific profile
ProfilesApi	controller_get_profiles_by_resource_profiles_path_resource_get	GET /api/janus/controller/profiles/{resource}	Get profiles for a resource
ProfilesApi	controller_get_profiles_default_profiles_get	GET /api/janus/controller/profiles	Get host profiles (default)
ProfilesApi	controller_post_profile_profiles_path_resource_path_rname_post	POST /api/janus/controller/profiles/{resource}/{rname}	Create a new profile
ProfilesApi	controller_put_profile_profiles_path_resource_path_rname_put	PUT /api/janus/controller/profiles/{resource}/{rname}	Update a profile
SessionsApi	controller_create_sessions_create_post	POST /api/janus/controller/create	Create one or more new sessions.
SessionsApi	controller_delete_active_active_int_aid_delete	DELETE /api/janus/controller/active/{aid}	Delete a specific active session
SessionsApi	controller_exec_command_exec_post	POST /api/janus/controller/exec	Execute a container command inside an active session.
SessionsApi	controller_get_active_active_get	GET /api/janus/controller/active	Get all active sessions
SessionsApi	controller_get_active_by_id_active_int_aid_get	GET /api/janus/controller/active/{aid}	Get a specific active session
SessionsApi	controller_get_logs_active_int_aid_logs_path_nname_get	GET /api/janus/controller/active/{aid}/logs/{nname}	Display logs for a specific active session and node.
SessionsApi	controller_post_active_apply_active_int_aid_apply_post	POST /api/janus/controller/active/{aid}/apply	Apply changes to a session
SessionsApi	controller_put_active_active_int_aid_put	PUT /api/janus/controller/active/{aid}	Update a specific active session
SessionsApi	controller_start_session_endpoint_start_int_aid_put	PUT /api/janus/controller/start/{aid}	Start a container service by id.
SessionsApi	controller_stop_session_endpoint_stop_int_aid_put	PUT /api/janus/controller/stop/{aid}	Stop a container service by id.
DefaultApi	controller_check_token_token_get	GET /api/janus/controller/token	Check Token
DefaultApi	controller_get_token_token_post	POST /api/janus/controller/token	Get Token

Documentation For Models

• AddEndpointRequest
• AuthBulkRequest
• AuthBulkResponse
• AuthInfoResponse
• AuthRequest
• CheckTokenResponse
• ErrorResponse
• ExecRequest
• ExecResponse
• Id
• IdentifiersInner
• ImageResponse
• InstancesInner
• NodeResponse
• ProfileRequest
• ProfileResponse
• SessionRequest
• SessionRequestList
• SessionResponse
• TokenResponse
• ValidationErrorModel

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

jwt

• Type: Bearer authentication (JWT)

Author