bacalhau-apiclient 1.1.0.dev0

A Python client for the Bacalhau public API - https://github.com/bacalhau-project/bacalhau/tree/main/clients/python

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: ${PYPI_VERSION}
• Package version: 1.1.0.dev0
• 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.HealthApi(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 HealthApi->api_serverdebug: %s\n" % e)

# create an instance of the API class
api_instance = bacalhau_apiclient.HealthApi(bacalhau_apiclient.ApiClient(configuration))

try:
    # Returns debug information on what the current node is doing.
    api_response = api_instance.debug()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HealthApi->debug: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://bootstrap.production.bacalhau.org:1234/

Class	Method	HTTP request	Description
HealthApi	api_serverdebug	GET /api/v1/compute/debug	Returns debug information on what the current node is doing.
HealthApi	debug	GET /api/v1/requester/debug	Returns debug information on what the current node is doing.
JobApi	cancel	POST /api/v1/requester/cancel	Cancels the job with the job-id specified in the body payload.
JobApi	events	POST /api/v1/requester/events	Returns the events related to the job-id passed in the body payload. Useful for troubleshooting.
JobApi	list	POST /api/v1/requester/list	Simply lists jobs.
JobApi	logs	POST /api/v1/requester/logs	Displays the logs for a current job/execution
JobApi	results	POST /api/v1/requester/results	Returns the results of the job-id specified in the body payload.
JobApi	states	POST /api/v1/requester/states	Returns the state of the job-id specified in the body payload.
JobApi	submit	POST /api/v1/requester/submit	Submits a new job to the network.
MiscApi	api_serverversion	POST /api/v1/version	Returns the build version running on the server.
OpsApi	agentalive	GET /api/v1/agent/alive
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.
UtilsApi	healthz	GET /api/v1/healthz
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.
UtilsApi	peers	GET /api/v1/peers	Returns the peers connected to the host via the transport layer.
DefaultApi	api_serverapprover	GET /api/v1/compute/approve	Approves a job to be run on this compute node.
DefaultApi	nodes	GET /api/v1/requester/nodes	Displays the nodes that this requester knows about

Documentation For Models

• AllOfExecutionStateDesiredState
• AllOfExecutionStatePublishedResults
• AllOfExecutionStateRunOutput
• AllOfExecutionStateState
• AllOfJobCreatePayloadSpec
• AllOfJobMetadata
• AllOfJobSpec
• AllOfJobSpecWasmEntryModule
• AllOfJobStateState
• AllOfJobWithInfoJob
• AllOfJobWithInfoState
• AllOfLabelSelectorRequirementOperator
• AllOfSpecDeal
• AllOfSpecDocker
• AllOfSpecEngine
• AllOfSpecNetwork
• AllOfSpecPublisher
• AllOfSpecResources
• AllOfSpecWasm
• AllOfStorageSpecStorageSource
• AllOflegacyCancelRequestPayload
• AllOflegacyEventsRequestFilters
• AllOflegacyLogRequestPayload
• AllOflegacySubmitRequestPayload
• ApiGetVersionResponse
• BuildVersionInfo
• ComputeNodeInfo
• Deal
• Engine
• EngineSpec
• ExecutionDesiredState
• ExecutionState
• ExecutionStateType
• FreeSpace
• HealthInfo
• Job
• JobCancelPayload
• JobCreatePayload
• JobHistory
• JobHistoryType
• JobRequester
• JobSpecDocker
• JobSpecWasm
• JobState
• JobStateType
• JobWithInfo
• LabelSelectorRequirement
• LegacyCancelRequest
• LegacyCancelResponse
• LegacyEventFilterOptions
• LegacyEventsRequest
• LegacyEventsResponse
• LegacyListRequest
• LegacyListResponse
• LegacyLogRequest
• LegacyResultsResponse
• LegacyStateRequest
• LegacyStateResponse
• LegacySubmitRequest
• LegacySubmitResponse
• LegacyVersionRequest
• LegacyVersionResponse
• LogsPayload
• Metadata
• MountStatus
• Network
• NetworkConfig
• NodeInfo
• NodeType
• PeerAddrInfo
• PublishedResult
• Publisher
• PublisherSpec
• ResourceUsageConfig
• Resources
• RunCommandResult
• S3StorageSpec
• SelectionOperator
• Spec
• StateChangeExecutionStateType
• StateChangeJobStateType
• StorageSourceType
• StorageSpec

Documentation For Authorization

All endpoints do not require authorization.

Author

[e-mail]