List instructions

GET

https://api.dsx-air.nvidia.com/api/v3/simulations/nodes/instructions/

List instructions visible to your account.

Required scope: air:simulation_read (roles: air_org_admin, air_user)

Alternative: role air_trainee also grants access.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

created_by_clientbooleanOptional

executorenumOptional

init - Initialize the node’s hostname
file - Write files to the node’s file system
shell - Execute shell commands on the node

* `init` - Initialize the node's hostname * `file` - Write files to the node's file system * `shell` - Execute shell commands on the node

Allowed values:

limitintegerOptional

Number of results to return per page.

namestringOptional

nodestringOptionalformat: "uuid"

offsetintegerOptional

The initial index from which to return the results.

orderingenumOptional

Order objects by field. Prefix with - for descending order.

run_again_on_rebuildbooleanOptional

searchstringOptional

Search by name.

simulationstringOptionalformat: "uuid"

stateenumOptional

The current lifecycle state of this instruction. Defaults to NOT_READY; transitions to READY once the target VM is running.

NOT_READY - The instruction exists but is not yet ready for worker pickup.
READY - The instruction is ready to be picked up and executed.
IN_PROGRESS - The instruction has been picked up by the worker.
COMPLETE - The instruction was successfully executed.
FAILED - The instruction failed to finish execution.
CANCELLED - The instruction was cancelled before execution.

The current lifecycle state of this instruction. Defaults to NOT_READY; transitions to READY once the target VM is running. * `NOT_READY` - The instruction exists but is not yet ready for worker pickup. * `READY` - The instruction is ready to be picked up and executed. * `IN_PROGRESS` - The instruction has been picked up by the worker. * `COMPLETE` - The instruction was successfully executed. * `FAILED` - The instruction failed to finish execution. * `CANCELLED` - The instruction was cancelled before execution.

Response

countinteger

resultslist of objects

nextstring or nullOptionalformat: "uri"

previousstring or nullOptionalformat: "uri"

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error