Go API client for slurmrestapi

API to access and control Slurm.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: v0.0.39
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.schedmd.com/

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import slurmrestapi "github.com/zhuqw12/slurmrestapi"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), slurmrestapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), slurmrestapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), slurmrestapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), slurmrestapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
OpenapiAPI	OpenapiGet	Get /openapi	Retrieve OpenAPI Specification
OpenapiAPI	OpenapiJsonGet	Get /openapi.json	Retrieve OpenAPI Specification
OpenapiAPI	OpenapiV3Get	Get /openapi/v3	Retrieve OpenAPI Specification
OpenapiAPI	OpenapiYamlGet	Get /openapi.yaml	Retrieve OpenAPI Specification
SlurmAPI	SlurmV0039CancelJob	Delete /slurm/v0.0.39/job/{job_id}	cancel or signal job
SlurmAPI	SlurmV0039DeleteNode	Delete /slurm/v0.0.39/node/{node_name}	delete node
SlurmAPI	SlurmV0039Diag	Get /slurm/v0.0.39/diag	get diagnostics
SlurmAPI	SlurmV0039GetJob	Get /slurm/v0.0.39/job/{job_id}	get job info
SlurmAPI	SlurmV0039GetJobs	Get /slurm/v0.0.39/jobs	get list of jobs
SlurmAPI	SlurmV0039GetNode	Get /slurm/v0.0.39/node/{node_name}	get node info
SlurmAPI	SlurmV0039GetNodes	Get /slurm/v0.0.39/nodes	get all node info
SlurmAPI	SlurmV0039GetPartition	Get /slurm/v0.0.39/partition/{partition_name}	get partition info
SlurmAPI	SlurmV0039GetPartitions	Get /slurm/v0.0.39/partitions	get all partition info
SlurmAPI	SlurmV0039GetReservation	Get /slurm/v0.0.39/reservation/{reservation_name}	get reservation info
SlurmAPI	SlurmV0039GetReservations	Get /slurm/v0.0.39/reservations	get all reservation info
SlurmAPI	SlurmV0039Ping	Get /slurm/v0.0.39/ping	ping test
SlurmAPI	SlurmV0039SlurmctldGetLicenses	Get /slurm/v0.0.39/licenses	get all Slurm tracked license info
SlurmAPI	SlurmV0039SubmitJob	Post /slurm/v0.0.39/job/submit	submit new job
SlurmAPI	SlurmV0039UpdateJob	Post /slurm/v0.0.39/job/{job_id}	update job
SlurmAPI	SlurmV0039UpdateNode	Post /slurm/v0.0.39/node/{node_name}	update node properties
SlurmAPI	SlurmdbV0039AddClusters	Post /slurmdb/v0.0.39/clusters	Add clusters
SlurmAPI	SlurmdbV0039AddWckeys	Post /slurmdb/v0.0.39/wckeys	Add wckeys
SlurmAPI	SlurmdbV0039DeleteAccount	Delete /slurmdb/v0.0.39/account/{account_name}	Delete account
SlurmAPI	SlurmdbV0039DeleteAssociation	Delete /slurmdb/v0.0.39/association	Delete association
SlurmAPI	SlurmdbV0039DeleteAssociations	Delete /slurmdb/v0.0.39/associations	Delete associations
SlurmAPI	SlurmdbV0039DeleteCluster	Delete /slurmdb/v0.0.39/cluster/{cluster_name}	Delete cluster
SlurmAPI	SlurmdbV0039DeleteQos	Delete /slurmdb/v0.0.39/qos/{qos_name}	Delete QOS
SlurmAPI	SlurmdbV0039DeleteUser	Delete /slurmdb/v0.0.39/user/{user_name}	Delete user
SlurmAPI	SlurmdbV0039DeleteWckey	Delete /slurmdb/v0.0.39/wckey/{wckey}	Delete wckey
SlurmAPI	SlurmdbV0039Diag	Get /slurmdb/v0.0.39/diag	Get slurmdb diagnostics
SlurmAPI	SlurmdbV0039GetAccount	Get /slurmdb/v0.0.39/account/{account_name}	Get account info
SlurmAPI	SlurmdbV0039GetAccounts	Get /slurmdb/v0.0.39/accounts	Get account list
SlurmAPI	SlurmdbV0039GetAssociation	Get /slurmdb/v0.0.39/association	Get association info
SlurmAPI	SlurmdbV0039GetAssociations	Get /slurmdb/v0.0.39/associations	Get association list
SlurmAPI	SlurmdbV0039GetCluster	Get /slurmdb/v0.0.39/cluster/{cluster_name}	Get cluster info
SlurmAPI	SlurmdbV0039GetClusters	Get /slurmdb/v0.0.39/clusters	Get cluster list
SlurmAPI	SlurmdbV0039GetConfig	Get /slurmdb/v0.0.39/config	Dump all configuration information
SlurmAPI	SlurmdbV0039GetJob	Get /slurmdb/v0.0.39/job/{job_id}	Get job info
SlurmAPI	SlurmdbV0039GetJobs	Get /slurmdb/v0.0.39/jobs	Get job list
SlurmAPI	SlurmdbV0039GetQos	Get /slurmdb/v0.0.39/qos	Get QOS list
SlurmAPI	SlurmdbV0039GetSingleQos	Get /slurmdb/v0.0.39/qos/{qos_name}	Get QOS info
SlurmAPI	SlurmdbV0039GetTres	Get /slurmdb/v0.0.39/tres	Get TRES info
SlurmAPI	SlurmdbV0039GetUser	Get /slurmdb/v0.0.39/user/{user_name}	Get user info
SlurmAPI	SlurmdbV0039GetUsers	Get /slurmdb/v0.0.39/users	Get user list
SlurmAPI	SlurmdbV0039GetWckey	Get /slurmdb/v0.0.39/wckey/{wckey}	Get wckey info
SlurmAPI	SlurmdbV0039GetWckeys	Get /slurmdb/v0.0.39/wckeys	Get wckey list
SlurmAPI	SlurmdbV0039SetConfig	Post /slurmdb/v0.0.39/config	Load all configuration information
SlurmAPI	SlurmdbV0039UpdateAccounts	Post /slurmdb/v0.0.39/accounts	Update accounts
SlurmAPI	SlurmdbV0039UpdateAssociations	Post /slurmdb/v0.0.39/associations	Set associations info
SlurmAPI	SlurmdbV0039UpdateQos	Post /slurmdb/v0.0.39/qos	Set QOS info
SlurmAPI	SlurmdbV0039UpdateTres	Post /slurmdb/v0.0.39/tres	Set TRES info
SlurmAPI	SlurmdbV0039UpdateUsers	Post /slurmdb/v0.0.39/users	Update user

Documentation For Models

• Dbv0039AccountInfo
• Dbv0039AssociationsInfo
• Dbv0039ClustersInfo
• Dbv0039ConfigInfo
• Dbv0039Diag
• Dbv0039Error
• Dbv0039JobInfo
• Dbv0039Meta
• Dbv0039MetaPlugin
• Dbv0039MetaSlurm
• Dbv0039MetaSlurmVersion
• Dbv0039QosInfo
• Dbv0039ResponseAssociationsDelete
• Dbv0039SetConfig
• Dbv0039TresInfo
• Dbv0039TresUpdate
• Dbv0039UpdateQos
• Dbv0039UpdateUsers
• Dbv0039UserInfo
• Dbv0039Warning
• Dbv0039WckeyInfo
• Status
• V0039Account
• V0039Accounting
• V0039AccountingAllocated
• V0039AcctGatherEnergy
• V0039Assoc
• V0039AssocDefault
• V0039AssocMax
• V0039AssocMaxJobs
• V0039AssocMaxJobsPer
• V0039AssocMin
• V0039AssocShort
• V0039AssocUsage
• V0039ClusterRec
• V0039ClusterRecAssociations
• V0039ClusterRecController
• V0039ControllerPing
• V0039Coord
• V0039CronEntry
• V0039CronEntryLine
• V0039Diag
• V0039Error
• V0039ExtSensorsData
• V0039Float64NoVal
• V0039Job
• V0039JobArray
• V0039JobArrayResponseMsgInner
• V0039JobComment
• V0039JobDescMsg
• V0039JobExitCode
• V0039JobExitCodeSignal
• V0039JobHet
• V0039JobInfo
• V0039JobInfoPower
• V0039JobMcs
• V0039JobRequired
• V0039JobRes
• V0039JobReservation
• V0039JobState
• V0039JobSubmission
• V0039JobSubmissionResponse
• V0039JobTime
• V0039JobTimeUser
• V0039JobTres
• V0039JobUpdateResponse
• V0039JobsResponse
• V0039License
• V0039LicensesInfo
• V0039Meta
• V0039Node
• V0039NodesResponse
• V0039PartitionInfo
• V0039PartitionInfoAccounts
• V0039PartitionInfoDefaults
• V0039PartitionInfoGroups
• V0039PartitionInfoMaximums
• V0039PartitionInfoMinimums
• V0039PartitionInfoNodes
• V0039PartitionInfoPriority
• V0039PartitionInfoQos
• V0039PartitionInfoTimeouts
• V0039PartitionInfoTres
• V0039PartitionsResponse
• V0039Pings
• V0039PowerMgmtData
• V0039Qos
• V0039QosLimits
• V0039QosLimitsMin
• V0039QosLimitsMinTres
• V0039QosLimitsMinTresPer
• V0039QosPreempt
• V0039ReservationCoreSpec
• V0039ReservationInfo
• V0039ReservationInfoPurgeCompleted
• V0039ReservationsResponse
• V0039RollupStatsInner
• V0039SlurmStepId
• V0039StatsMsg
• V0039StatsMsgRpcsByTypeInner
• V0039StatsMsgRpcsByUserInner
• V0039StatsRec
• V0039StatsRpc
• V0039StatsRpcTime
• V0039StatsUser
• V0039Step
• V0039StepCPU
• V0039StepNodes
• V0039StepStatistics
• V0039StepStatisticsEnergy
• V0039StepTask
• V0039StepTasks
• V0039StepTime
• V0039StepTimeUser
• V0039StepTres
• V0039Tres
• V0039Uint16NoVal
• V0039Uint32NoVal
• V0039Uint64NoVal
• V0039UpdateNodeMsg
• V0039User
• V0039UserDefault
• V0039Warning
• V0039Wckey
• V0039WckeyTag

Documentation For Authorization

Authentication schemes defined for the API:

user

• Type: API key
• API key parameter name: X-SLURM-USER-NAME
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-SLURM-USER-NAME and passed in as the auth context for each request.

token

• Type: API key
• API key parameter name: X-SLURM-USER-TOKEN
• Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-SLURM-USER-TOKEN and passed in as the auth context for each request.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

[email protected]