hpc-acm 1.0.5

HPC Web API

hpc-acm

Preview

This Python package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

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 hpc_acm 

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 hpc_acm

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import hpc_acm
from hpc_acm.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basic_auth
hpc_acm.configuration.username = 'YOUR_USERNAME'
hpc_acm.configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = hpc_acm.DefaultApi()
id = 56 # int | Job id
job = hpc_acm.JobUpdate() # JobUpdate |  (optional)

try:
    # Cancel a clusrun
    api_instance.cancel_clusrun_job(id, job=job)
except ApiException as e:
    print("Exception when calling DefaultApi->cancel_clusrun_job: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://localhost/v1

Class	Method	HTTP request	Description
DefaultApi	cancel_clusrun_job	PATCH /clusrun/{id}	Cancel a clusrun
DefaultApi	cancel_diagnostic_job	PATCH /diagnostics/{id}	Cancel a diagnostic test run
DefaultApi	create_clusrun_job	POST /clusrun	Create a clusrun
DefaultApi	create_diagnostic_job	POST /diagnostics	Create a diagnostic test run
DefaultApi	get_clus_run_job_summary	GET /dashboard/clusrun	Get summary of ClusRun jobs
DefaultApi	get_clusrun_job	GET /clusrun/{id}	Get a clusrun
DefaultApi	get_clusrun_job_aggregation_result	GET /clusrun/{id}/aggregationResult	Get aggregation result of a clusrun job
DefaultApi	get_clusrun_jobs	GET /clusrun	Get a list of clusruns
DefaultApi	get_clusrun_output	GET /output/clusrun/{key}/raw	Get the whole output of a task
DefaultApi	get_clusrun_output_in_page	GET /output/clusrun/{key}/page	Get partial output of a task
DefaultApi	get_clusrun_task	GET /clusrun/{id}/tasks/{taskId}	Get a task of a clusrun
DefaultApi	get_clusrun_task_result	GET /clusrun/{id}/tasks/{taskId}/result	Get a task result of a clusrun
DefaultApi	get_clusrun_tasks	GET /clusrun/{id}/tasks	Get tasks of a clusrun
DefaultApi	get_diagnostic_job	GET /diagnostics/{id}	Get a diagnostic test run
DefaultApi	get_diagnostic_job_aggregation_result	GET /diagnostics/{id}/aggregationResult	Get aggregation result of a diagnostic job
DefaultApi	get_diagnostic_job_summary	GET /dashboard/diagnostics	Get summary of diagnostic jobs
DefaultApi	get_diagnostic_jobs	GET /diagnostics	Get a list of diagnostic test runs
DefaultApi	get_diagnostic_task	GET /diagnostics/{id}/tasks/{taskId}	Get a task of a diagnostic test run
DefaultApi	get_diagnostic_task_result	GET /diagnostics/{id}/tasks/{taskId}/result	Get a task result of a diagnostic test run
DefaultApi	get_diagnostic_tasks	GET /diagnostics/{id}/tasks	Get tasks of a diagnostic test run
DefaultApi	get_diagnostic_tests	GET /diagnostics/tests	Get available diagnostic tests
DefaultApi	get_metric_categories	GET /metrics/categories	Get node metric categories
DefaultApi	get_metrics_of_category	GET /metrics/{category}	Get node merics in a category
DefaultApi	get_node	GET /nodes/{id}	Get a node
DefaultApi	get_node_events	GET /nodes/{id}/events	Get events of a node
DefaultApi	get_node_jobs	GET /nodes/{id}/jobs	Get jobs of a node
DefaultApi	get_node_metadata	GET /nodes/{id}/metadata	get metadata of a node
DefaultApi	get_node_metric_history	GET /nodes/{id}/metricHistory	Get metric history of a node
DefaultApi	get_node_scheduled_events	GET /nodes/{id}/scheduledEvents	get scheduled events of a node
DefaultApi	get_node_summary	GET /dashboard/nodes	Get summary of nodes
DefaultApi	get_nodes	GET /nodes	Get a list of nodes

Documentation For Models

• DiagnoticTest
• Event
• IpV4
• IpV6
• Job
• JobState
• JobSummary
• JobType
• JobUpdate
• MacAddress
• Metrics
• MetricsValues
• Node
• NodeGpu
• NodeJob
• NodeMetadata
• NodeMetadataCompute
• NodeMetadataNetwork
• NodeMetadataNetworkInterface
• NodeMetadataNetworkIpv4
• NodeMetadataNetworkIpv4IpAddress
• NodeMetadataNetworkIpv4Subnet
• NodeMetadataNetworkIpv6
• NodeMetrics
• NodeMetricsData
• NodeMetricsMetricItems
• NodeNetwork
• NodeRegistration
• NodeSummary
• ScheduledEvent
• ScheduledEvents
• Task
• TaskOutput
• TaskResult
• TaskState

Documentation For Authorization

basic_auth

• Type: HTTP basic authentication

Author