Altair SLC Hub Management (2024.0.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Queries current nodes

Authorizations:

bearerAuth

query Parameters

filter[status][EQ]	string (nodeStatus) Enum: "initializing" "ready" "down" "unknown"
filter[status][IN]	string
filter[isWorker][EQ]	boolean
filter[isServer][EQ]	boolean
filter[nodeLabels][ALL]	Array of strings
filter[nodeLabels][ANY]	Array of strings
page[offset]	integer
page[limit]	integer
sort	string Enum: "id" "-id" "name" "-name" "address" "-address" "status" "-status"

Responses

Response samples

200

Content type

application/json

{"total": 0,
"data": [{"id": "string",
"name": "string",
"address": "string",
"type": "server",
"isWorker": true,
"isServer": true,
"status": "initializing",
"nodeLabels": ["string"
]
}
]
}

Returns the given node

Authorizations:

bearerAuth

path Parameters

nodeId

required

string

ID of the node

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"name": "string",
"hostname": "string",
"address": "string",
"resources": {"memory": 0,
"cpu": 0
},
"type": "server",
"isWorker": true,
"isServer": true,
"status": "initializing",
"attributes": {"property1": "string",
"property2": "string"
}
}

Returns resource usage stats for the given node

Authorizations:

bearerAuth

path Parameters

nodeId

required

string

ID of the node

Responses

Response samples

200
404

Content type

application/json

{"uptime": 0,
"memory": {"total": 0,
"available": 0,
"used": 0,
"free": 0
},
"cpu": {"ticksConsumed": null
}
}

queries details about the jobs running in the cluster

Authorizations:

bearerAuth

query Parameters

filter[name][ST]	string
filter[name][CO]	string
filter[status][EQ]	string (jobStatus) Enum: "pending" "running" "dead"
filter[status][IN]	Array of strings (jobStatus) Items Enum: "pending" "running" "dead"
filter[type][EQ]	string (jobType) Enum: "batch" "service"
filter[submitTime][LT]	string <date-time> Filters jobs by submit time
filter[submitTime][GT]	string <date-time> Filters jobs by submit time
page[offset]	integer
page[limit]	integer
sort	string Enum: "name" "-name" "status" "-status" "type" "-type" "submitTime" "-submitTime"

Responses

Response samples

200

Content type

application/json

{"total": 0,
"data": [{"id": "string",
"name": "string",
"status": "pending",
"type": "batch",
"submitTime": "2019-08-24T14:15:22Z",
"priority": 1,
"taskSummary": {"queued": 0,
"completed": 0,
"failed": 0,
"running": 0,
"starting": 0,
"lost": 0
}
}
]
}

gets extended information about the given job

Authorizations:

bearerAuth

path Parameters

jobId

required

string

ID of the job

query Parameters

page[offset]	integer
page[limit]	integer

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"name": "string",
"status": "pending",
"type": "batch",
"submitTime": "2019-08-24T14:15:22Z",
"priority": 1,
"properties": {"property1": "string",
"property2": "string"
}
}

queryJobExecutions

Authorizations:

bearerAuth

query Parameters

filter[jobId][EQ]	string
filter[nodeId][EQ]	string
filter[status][EQ]	string (jobExecutionStatus) Enum: "pending" "running" "complete" "failed" "lost"
filter[status][IN]	Array of strings (jobExecutionStatus) Items Enum: "pending" "running" "complete" "failed" "lost"
filter[creationTime][LT]	string <date-time>
filter[creationTime][GT]	string <date-time>
filter[modifiedTime][LT]	string <date-time>
filter[modifiedTime][GT]	string <date-time>
page[offset]	integer
page[limit]	integer

Responses

Response samples

200

Content type

application/json

{"total": 0,
"data": [{"id": "string",
"jobId": "string",
"status": "pending",
"creationTime": "2019-08-24T14:15:22Z",
"modifiedTime": "2019-08-24T14:15:22Z",
"nodeId": "string",
"nodeName": "string"
}
]
}

getJobExecutionInfo

Authorizations:

bearerAuth

path Parameters

jobExecutionId

required

string

ID of the job execution

Responses

Response samples

200
404

Content type

application/json

{"id": "string",
"jobId": "string",
"status": "pending",
"creationTime": "2019-08-24T14:15:22Z",
"modifiedTime": "2019-08-24T14:15:22Z",
"nodeId": "string",
"nodeName": "string",
"taskStates": {"property1": {"status": "pending",
"failed": true,
"restarts": 0,
"lastRestart": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"events": [{"type": "string",
"time": "2019-08-24T14:15:22Z",
"displayMessage": "string",
"details": { },
"message": "string"
}
]
},
"property2": {"status": "pending",
"failed": true,
"restarts": 0,
"lastRestart": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"events": [{"type": "string",
"time": "2019-08-24T14:15:22Z",
"displayMessage": "string",
"details": { },
"message": "string"
}
]
}
},
"resources": {"reservedCPU": 0,
"reservedMemory": 0
},
"jobProperties": {"property1": "string",
"property2": "string"
}
}

listExecutionLogs

Returns a list of the available logs for the job

Authorizations:

bearerAuth

path Parameters

jobExecutionId required	string ID of the job execution
taskName required	string name of the task

Responses

Response samples

200
404

Content type

application/json

["string"
]

getJobExecutionLog

Returns the content of one of the job execution log files.

Authorizations:

bearerAuth

path Parameters

jobExecutionId required	string ID of the job execution
taskName required	string name of the task
logname required	string

query Parameters

origin	string Enum: "start" "end" Specifies the origin for where in the log to start reading from. Default is "start"
offset	integer <int64> Specifies where in the log to start reading from, relative to the origin.
limit	integer <int32> Specifies the maximum amount of content to return

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

listJobExecutionFiles

Authorizations:

bearerAuth

path Parameters

jobExecutionId required	string ID of the job execution
path	string

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

getJobExecutionFile

Authorizations:

bearerAuth

path Parameters

jobExecutionId required	string ID of the job execution
path	string

query Parameters

offset	integer <int64> Specifies where in the file to start reading from
limit	integer <int32> Specifies the maximum amount of content to return

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

getJobExecutionStats

Authorizations:

bearerAuth

path Parameters

jobExecutionId

required

string

ID of the job execution

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

restartJobExecution

Authorizations:

bearerAuth

path Parameters

jobExecutionId

required

string

ID of the job execution

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

stopJobExecution

Authorizations:

bearerAuth

path Parameters

jobExecutionId

required

string

ID of the job execution

Responses

Response samples

404

Content type

application/json

{"msg": "string"
}

getVersionInfo

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

{"version": "string"
}

runGarbageCollection

Authorizations:

bearerAuth

Responses

Returns a list of all attributes on nodes

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

["string"
]

Returns a list of all labels on nodes

Authorizations:

bearerAuth

Responses

Response samples

200

Content type

application/json

["string"
]