janus-py-client 1.1

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"
)



# 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.JanusAgentApi(api_client)
    tune_request = janus_py_client.TuneRequest() # TuneRequest | 

    try:
        # Delete netem rules
        api_instance.agent_delete_tc_netem_tc_netem_delete(tune_request)
    except ApiException as e:
        print("Exception when calling JanusAgentApi->agent_delete_tc_netem_tc_netem_delete: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
JanusAgentApi	agent_delete_tc_netem_tc_netem_delete	DELETE /api/janus/agent/tc/netem	Delete netem rules
JanusAgentApi	agent_delete_tc_pacing_tc_pacing_delete	DELETE /api/janus/agent/tc/pacing	Delete pacing rules
JanusAgentApi	agent_get_node_node_get	GET /api/janus/agent/node	Returns static node resources
JanusAgentApi	agent_get_tc_delay_tc_delay_get	GET /api/janus/agent/tc/delay	Get delay rules
JanusAgentApi	agent_get_tc_filter_tc_filter_get	GET /api/janus/agent/tc/filter	Get filter rules
JanusAgentApi	agent_get_tc_latency_tc_latency_get	GET /api/janus/agent/tc/latency	Get latency rules
JanusAgentApi	agent_get_tc_netem_tc_netem_get	GET /api/janus/agent/tc/netem	Get netem rules
JanusAgentApi	agent_get_tc_pacing_tc_pacing_get	GET /api/janus/agent/tc/pacing	Get pacing rules
JanusAgentApi	agent_get_tune_endpoint_tune_get	GET /api/janus/agent/tune	Get node tuning settings
JanusAgentApi	agent_post_tc_delay_tc_delay_post	POST /api/janus/agent/tc/delay	Set delay rules
JanusAgentApi	agent_post_tc_filter_tc_filter_post	POST /api/janus/agent/tc/filter	Set filter rules
JanusAgentApi	agent_post_tc_latency_tc_latency_post	POST /api/janus/agent/tc/latency	Set latency rules
JanusAgentApi	agent_post_tc_netem_tc_netem_post	POST /api/janus/agent/tc/netem	Set netem rules
JanusAgentApi	agent_post_tc_pacing_tc_pacing_post	POST /api/janus/agent/tc/pacing	Set pacing rules
JanusAgentApi	agent_post_tune_endpoint_tune_post	POST /api/janus/agent/tune	Set node tuning settings
JanusControllerApi	controller_add_node_nodes_post	POST /api/janus/controller/nodes	Add a new node
JanusControllerApi	controller_check_token_token_get	GET /api/janus/controller/token	Check Token
JanusControllerApi	controller_create_sessions_create_post	POST /api/janus/controller/create	Create one or more new sessions.
JanusControllerApi	controller_delete_active_active_int_aid_delete	DELETE /api/janus/controller/active/{aid}	Delete a specific active session
JanusControllerApi	controller_delete_auth_auth_path_resource_int_rid_delete	DELETE /api/janus/controller/auth/{resource}/{rid}	Delete auth info by ID
JanusControllerApi	controller_delete_auth_auth_path_resource_path_rname_delete	DELETE /api/janus/controller/auth/{resource}/{rname}	Delete auth info by name
JanusControllerApi	controller_delete_node_nodes_int_id_delete	DELETE /api/janus/controller/nodes/{id}	Delete node by ID
JanusControllerApi	controller_delete_node_nodes_node_delete	DELETE /api/janus/controller/nodes/{node}	Delete node by name
JanusControllerApi	controller_delete_profile_profiles_path_resource_path_rname_delete	DELETE /api/janus/controller/profiles/{resource}/{rname}	Remove a profile
JanusControllerApi	controller_exec_command_exec_post	POST /api/janus/controller/exec	Execute a container command inside an active session.
JanusControllerApi	controller_get_active_active_get	GET /api/janus/controller/active	Get all active sessions
JanusControllerApi	controller_get_active_by_id_active_int_aid_get	GET /api/janus/controller/active/{aid}	Get a specific active session
JanusControllerApi	controller_get_auth_auth_path_resource_get	GET /api/janus/controller/auth/{resource}	Get auth info
JanusControllerApi	controller_get_auth_auth_path_resource_int_rid_get	GET /api/janus/controller/auth/{resource}/{rid}	Get specific auth info by ID
JanusControllerApi	controller_get_auth_auth_path_resource_path_rname_get	GET /api/janus/controller/auth/{resource}/{rname}	Get specific auth info by name
JanusControllerApi	controller_get_images_images_get	GET /api/janus/controller/images	Get images
JanusControllerApi	controller_get_images_images_path_name_get	GET /api/janus/controller/images/{name}	Get a specific image
JanusControllerApi	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.
JanusControllerApi	controller_get_node_by_id_or_name_nodes_int_id_get	GET /api/janus/controller/nodes/{id}	Get node by ID
JanusControllerApi	controller_get_node_by_id_or_name_nodes_node_get	GET /api/janus/controller/nodes/{node}	Get node by name
JanusControllerApi	controller_get_nodes_nodes_get	GET /api/janus/controller/nodes	Get nodes
JanusControllerApi	controller_get_profile_by_name_profiles_path_resource_path_rname_get	GET /api/janus/controller/profiles/{resource}/{rname}	Get a specific profile
JanusControllerApi	controller_get_profiles_by_resource_profiles_path_resource_get	GET /api/janus/controller/profiles/{resource}	Get profiles for a resource
JanusControllerApi	controller_get_profiles_default_profiles_get	GET /api/janus/controller/profiles	Get host profiles (default)
JanusControllerApi	controller_get_token_token_post	POST /api/janus/controller/token	Get Token
JanusControllerApi	controller_post_active_apply_active_int_aid_apply_post	POST /api/janus/controller/active/{aid}/apply	Apply changes to a session
JanusControllerApi	controller_post_auth_auth_path_resource_int_rid_post	POST /api/janus/controller/auth/{resource}/{rid}	Update auth info by ID
JanusControllerApi	controller_post_auth_auth_path_resource_path_rname_post	POST /api/janus/controller/auth/{resource}/{rname}	Update auth info by name
JanusControllerApi	controller_post_auth_bulk_auth_bulk_post	POST /api/janus/controller/auth/bulk	Bulk update auth info
JanusControllerApi	controller_post_profile_profiles_path_resource_path_rname_post	POST /api/janus/controller/profiles/{resource}/{rname}	Create a new profile
JanusControllerApi	controller_put_active_active_int_aid_put	PUT /api/janus/controller/active/{aid}	Update a specific active session
JanusControllerApi	controller_put_profile_profiles_path_resource_path_rname_put	PUT /api/janus/controller/profiles/{resource}/{rname}	Update a profile
JanusControllerApi	controller_start_session_endpoint_start_int_aid_put	PUT /api/janus/controller/start/{aid}	Start a container service by id.
JanusControllerApi	controller_stop_session_endpoint_stop_int_aid_put	PUT /api/janus/controller/stop/{aid}	Stop a container service by id.

Documentation For Models

• AddEndpointRequest
• AuthBulkRequest
• AuthRequest
• ExecRequest
• IdentifiersInner
• InstancesInner
• ProfileRequest
• QoSAgent
• SessionRequest
• SessionRequestList
• TuneRequest
• ValidationErrorModel

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

jwt

• Type: Bearer authentication (JWT)

Author