bacalhau_apiclient
This page is the reference of the Bacalhau REST API. Project docs are available at https://docs.bacalhau.org/. Find more information about Bacalhau at https://github.com/bacalhau-project/bacalhau.
This Python package is automatically generated by the Swagger Codegen project:
- API version: ${VERSION}
- Package version:
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit https://github.com/bacalhau-project/bacalhau
Requirements.
Python 3.6+
Installation & Usage
pip install
If the python package is hosted on Github, you can install directly from Github
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 bacalhau_apiclient
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 bacalhau_apiclient
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import bacalhau_apiclient
from bacalhau_apiclient.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = bacalhau_apiclient.ComputeNodeApi(bacalhau_apiclient.ApiClient(configuration))
try:
# Approves a job to be run on this compute node.
api_response = api_instance.api_serverapprover()
pprint(api_response)
except ApiException as e:
print("Exception when calling ComputeNodeApi->api_serverapprover: %s\n" % e)
# create an instance of the API class
api_instance = bacalhau_apiclient.ComputeNodeApi(bacalhau_apiclient.ApiClient(configuration))
try:
# Returns debug information on what the current node is doing.
api_response = api_instance.api_serverdebug()
pprint(api_response)
except ApiException as e:
print("Exception when calling ComputeNodeApi->api_serverdebug: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://bootstrap.production.bacalhau.org:1234/
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ComputeNodeApi | api_serverapprover | GET /api/v1/compute/approve | Approves a job to be run on this compute node. |
| ComputeNodeApi | api_serverdebug | GET /api/v1/compute/debug | Returns debug information on what the current node is doing. |
| MiscApi | api_serverversion | POST /api/v1/version | Returns the build version running on the server. |
| OpsApi | agentalive | GET /api/v1/agent/alive | |
| OpsApi | agentdebug | GET /api/v1/agent/debug | Returns debug information on what the current node is doing. |
| OpsApi | agentnode | GET /api/v1/agent/node | Returns the info of the node. |
| OpsApi | agentversion | GET /api/v1/agent/version | Returns the build version running on the server. |
| OrchestratorApi | orchestratorget_job | GET /api/v1/orchestrator/jobs/{id} | Returns a job. |
| OrchestratorApi | orchestratorget_node | GET /api/v1/orchestrator/nodes/{id} | Get an orchestrator node |
| OrchestratorApi | orchestratorjob_executions | GET /api/v1/orchestrator/jobs/{id}/executions | Returns the executions of a job. |
| OrchestratorApi | orchestratorjob_history | GET /api/v1/orchestrator/jobs/{id}/history | Returns the history of a job. |
| OrchestratorApi | orchestratorjob_results | GET /api/v1/orchestrator/jobs/{id}/results | Returns the results of a job. |
| OrchestratorApi | orchestratorlist_jobs | GET /api/v1/orchestrator/jobs | Returns a list of jobs. |
| OrchestratorApi | orchestratorlist_nodes | GET /api/v1/orchestrator/nodes | Returns a list of orchestrator nodes. |
| OrchestratorApi | orchestratorlogs | GET /api/v1/orchestrator/jobs/{id}/logs | Displays the logs for a current job/execution |
| OrchestratorApi | orchestratorput_job | PUT /api/v1/orchestrator/jobs | Submits a job to the orchestrator. |
| OrchestratorApi | orchestratorstop_job | DELETE /api/v1/orchestrator/jobs/{id} | Stops a job. |
| OrchestratorApi | orchestratorupdate_node | POST /api/v1/orchestrator/nodes | Update an orchestrator node. |
| UtilsApi | healthz | GET /api/v1/healthz | |
| UtilsApi | home | GET / | |
| UtilsApi | id | GET /api/v1/id | Returns the id of the host node. |
| UtilsApi | livez | GET /api/v1/livez | |
| UtilsApi | node_info | GET /api/v1/node_info | Returns the info of the node. |
Documentation For Models
- AllOfExecutionAllocatedResources
- AllOfExecutionComputeState
- AllOfExecutionDesiredState
- AllOfExecutionJob
- AllOfExecutionPublishedResult
- AllOfExecutionRunOutput
- AllOfGPUVendor
- AllOfInputSourceSource
- AllOfJobState
- AllOfLabelSelectorRequirementOperator
- AllOfStateExecutionDesiredStateTypeStateType
- AllOfStateExecutionStateTypeStateType
- AllOfStateJobStateTypeStateType
- AllOfTaskResources
- AllocatedResources
- ApiGetJobResponse
- ApiGetNodeResponse
- ApiGetVersionResponse
- ApiHTTPCredential
- ApiListJobExecutionsResponse
- ApiListJobHistoryResponse
- ApiListJobResultsResponse
- ApiListJobsResponse
- ApiListNodesResponse
- ApiPutJobRequest
- ApiPutJobResponse
- ApiPutNodeRequest
- ApiPutNodeResponse
- ApiStopJobResponse
- BuildVersionInfo
- ComputeNodeInfo
- DebugInfo
- Event
- Execution
- ExecutionDesiredStateType
- ExecutionStateType
- FreeSpace
- GPU
- GPUVendor
- HealthInfo
- InputSource
- Job
- JobHistory
- JobHistoryType
- JobStateType
- LabelSelectorRequirement
- MountStatus
- Network
- NetworkConfig
- NodeConnectionState
- NodeInfo
- NodeMembershipState
- NodeState
- NodeType
- Resources
- ResourcesConfig
- ResultPath
- RunCommandResult
- SelectionOperator
- SharedVersionRequest
- SharedVersionResponse
- SpecConfig
- StateChangeExecutionStateType
- StateChangeJobStateType
- StateExecutionDesiredStateType
- StateExecutionStateType
- StateJobStateType
- Task
- TimeoutConfig
Documentation For Authorization
All endpoints do not require authorization.
Author
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
bacalhau_apiclient-1.4.1.tar.gz
(60.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bacalhau_apiclient-1.4.1.tar.gz.
File metadata
- Download URL: bacalhau_apiclient-1.4.1.tar.gz
- Upload date:
- Size: 60.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.1.1 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f06831c8e069a98cda6a705b5fe573ae4d031110186e5fea41178d26f1a0c86e
|
|
| MD5 |
18ba02308dfc6322ba4393e8324308f1
|
|
| BLAKE2b-256 |
2d3058be8e26393fb61a78cdc03181bb45e3d54af576a31f647fd63997c99534
|
File details
Details for the file bacalhau_apiclient-1.4.1-py3-none-any.whl.
File metadata
- Download URL: bacalhau_apiclient-1.4.1-py3-none-any.whl
- Upload date:
- Size: 129.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.1.1 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
745d4f0c37b4d67d412489453144e5d0514983eb5cc218fe7215ea01665ff84c
|
|
| MD5 |
c06dfb3b664d27dc4796ccd6b43ace88
|
|
| BLAKE2b-256 |
dcf0223e4ea5e23432aa48f189790f7219013a30553b399b446a7020c3a0ec81
|
