Package: bacalhau-apiclient
bacalhau_apiclientThis page is the reference of the Bacalhau REST API. Project docs are available athttps://docs.bacalhau.org/. Find more information about Bacalhau athttps://github.com/bacalhau-project/bacalhau.This Python package is automatically generated by theSwagger Codegenproject:API version: ${PYPI_VERSION}Package version: 1.2.1Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
For more information, please visithttps://github.com/bacalhau-project/bacalhauRequirements.Python 3.6+Installation & Usagepip installIf the python package is hosted on Github, you can install directly from Githubpipinstallgit+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)Then import the package:importbacalhau_apiclientSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importbacalhau_apiclientGetting StartedPlease follow theinstallation procedureand then run the following:from__future__importprint_functionimporttimeimportbacalhau_apiclientfrombacalhau_apiclient.restimportApiExceptionfrompprintimportpprint# create an instance of the API classapi_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)exceptApiExceptionase:print("Exception when calling ComputeNodeApi->api_serverapprover:%s\n"%e)# create an instance of the API classapi_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)exceptApiExceptionase:print("Exception when calling ComputeNodeApi->api_serverdebug:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttp://bootstrap.production.bacalhau.org:1234/ClassMethodHTTP requestDescriptionComputeNodeApiapi_serverapproverGET/api/v1/compute/approveApproves a job to be run on this compute node.ComputeNodeApiapi_serverdebugGET/api/v1/compute/debugReturns debug information on what the current node is doing.HealthApidebugGET/api/v1/requester/debugReturns debug information on what the current node is doing.JobApicancelPOST/api/v1/requester/cancelCancels the job with the job-id specified in the body payload.JobApieventsPOST/api/v1/requester/eventsReturns the events related to the job-id passed in the body payload. Useful for troubleshooting.JobApilistPOST/api/v1/requester/listSimply lists jobs.JobApilogsPOST/api/v1/requester/logsDisplays the logs for a current job/executionJobApiresultsPOST/api/v1/requester/resultsReturns the results of the job-id specified in the body payload.JobApistatesPOST/api/v1/requester/statesReturns the state of the job-id specified in the body payload.JobApisubmitPOST/api/v1/requester/submitSubmits a new job to the network.MiscApiapi_serverversionPOST/api/v1/versionReturns the build version running on the server.OpsApiagentaliveGET/api/v1/agent/aliveOpsApiagentdebugGET/api/v1/agent/debugReturns debug information on what the current node is doing.OpsApiagentnodeGET/api/v1/agent/nodeReturns the info of the node.OpsApiagentversionGET/api/v1/agent/versionReturns the build version running on the server.OrchestratorApiorchestratorjob_executionsGET/api/v1/orchestrator/jobs/{id}/executionsReturns the executions of a job.OrchestratorApiorchestratorjob_historyGET/api/v1/orchestrator/jobs/{id}/historyReturns the history of a job.OrchestratorApiorchestratorjob_resultsGET/api/v1/orchestrator/jobs/{id}/resultsReturns the results of a job.OrchestratorApiorchestratorlist_jobsGET/api/v1/orchestrator/jobsReturns a list of jobs.OrchestratorApiorchestratorput_jobPUT/api/v1/orchestrator/jobsSubmits a job to the orchestrator.OrchestratorApiorchestratorstop_jobDELETE/api/v1/orchestrator/jobs/{id}Stops a job.UtilsApihealthzGET/api/v1/healthzUtilsApihomeGET/UtilsApiidGET/api/v1/idReturns the id of the host node.UtilsApilivezGET/api/v1/livezUtilsApinode_infoGET/api/v1/node_infoReturns the info of the node.DefaultApinodesGET/api/v1/requester/nodesDisplays the nodes that this requester knows aboutDocumentation For ModelsAllOfExecutionAllocatedResourcesAllOfExecutionComputeStateAllOfExecutionDesiredStateAllOfExecutionJobAllOfExecutionPublishedResultAllOfExecutionRunOutputAllOfExecutionStateDesiredStateAllOfExecutionStatePublishedResultsAllOfExecutionStateRunOutputAllOfExecutionStateStateAllOfGPUVendorAllOfInputSourceSourceAllOfJobCreatePayloadSpecAllOfJobSpecWasmEntryModuleAllOfJobStateAllOfJobStateStateAllOfJobWithInfoJobAllOfJobWithInfoStateAllOfLabelSelectorRequirementOperatorAllOfSpecDealAllOfSpecDockerAllOfSpecEngineAllOfSpecNetworkAllOfSpecPublisherAllOfSpecResourcesAllOfSpecWasmAllOfStateExecutionDesiredStateTypeStateTypeAllOfStateExecutionStateTypeStateTypeAllOfStateJobStateTypeStateTypeAllOfStorageSpecStorageSourceAllOfTaskResourcesAllOflegacyCancelRequestPayloadAllOflegacyEventsRequestFiltersAllOflegacyLogRequestPayloadAllOflegacySubmitRequestPayloadAllocatedResourcesApiGetJobResponseApiGetVersionResponseApiListJobExecutionsResponseApiListJobHistoryResponseApiListJobResultsResponseApiListJobsResponseApiPutJobResponseApiStopJobResponseBuildVersionInfoComputeNodeInfoDealDebugInfoEngineEngineSpecExecutionExecutionDesiredStateExecutionDesiredStateTypeExecutionStateExecutionStateTypeFreeSpaceGPUGPUVendorHealthInfoInputSourceJobJobCancelPayloadJobCreatePayloadJobHistoryJobHistoryTypeJobRequesterJobSpecDockerJobSpecWasmJobStateJobStateTypeJobWithInfoLabelSelectorRequirementLegacyCancelRequestLegacyCancelResponseLegacyEventFilterOptionsLegacyEventsRequestLegacyEventsResponseLegacyListRequestLegacyListResponseLegacyLogRequestLegacyResultsResponseLegacyStateRequestLegacyStateResponseLegacySubmitRequestLegacySubmitResponseLegacyVersionRequestLegacyVersionResponseLogsPayloadMetadataMountStatusNetworkNetworkConfigNodeInfoNodeTypePeerAddrInfoPublishedResultPublisherPublisherSpecResourceUsageConfigResourcesResourcesConfigResultPathRunCommandResultS3StorageSpecSelectionOperatorSpecSpecConfigStateChangeExecutionStateTypeStateChangeJobStateTypeStateExecutionDesiredStateTypeStateExecutionStateTypeStateJobStateTypeStorageSourceTypeStorageSpecTaskTimeoutConfigDocumentation For AuthorizationAll endpoints do not require authorization.Authorteam@bacalhau.org