Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetSessionAction

Gets a session action for the job.

Request Syntax


GET /2023-10-12/farms/farmId/queues/queueId/jobs/jobId/session-actions/sessionActionId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

farmId

The farm ID for the session action.

Pattern: farm-[0-9a-f]{32}

Required: Yes

jobId

The job ID for the session.

Pattern: job-[0-9a-f]{32}

Required: Yes

queueId

The queue ID for the session action.

Pattern: queue-[0-9a-f]{32}

Required: Yes

sessionActionId

The session action ID for the session.

Pattern: sessionaction-[0-9a-f]{32}-(0|([1-9][0-9]{0,9}))

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "acquiredLimits": [ 
      { 
         "count": number,
         "limitId": "string"
      }
   ],
   "definition": { ... },
   "endedAt": "string",
   "manifests": [ 
      { 
         "outputManifestHash": "string",
         "outputManifestPath": "string"
      }
   ],
   "processExitCode": number,
   "progressMessage": "string",
   "progressPercent": number,
   "sessionActionId": "string",
   "sessionId": "string",
   "startedAt": "string",
   "status": "string",
   "workerUpdatedAt": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

acquiredLimits

The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.

Type: Array of AcquiredLimit objects

definition

The session action definition.

Type: SessionActionDefinition object

Note: This object is a Union. Only one member of this object can be specified or returned.

endedAt

The date and time the resource ended running.

Type: Timestamp

manifests

The list of manifest properties that describe file attachments for the task run.

Type: Array of TaskRunManifestPropertiesResponse objects

processExitCode

The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.

Type: Integer

Valid Range: Minimum value of -2147483648. Maximum value of 2147483647.

progressMessage

The message that communicates the progress of the session action.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

progressPercent

The percentage completed for a session action.

Type: Float

Valid Range: Minimum value of 0. Maximum value of 100.

sessionActionId

The session action ID.

Type: String

Pattern: sessionaction-[0-9a-f]{32}-(0|([1-9][0-9]{0,9}))

sessionId

The session ID for the session action.

Type: String

Pattern: session-[0-9a-f]{32}

startedAt

The date and time the resource started running.

Type: Timestamp

status

The status of the session action.

Type: String

workerUpdatedAt

The Linux timestamp of the date and time the session action was last updated.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action.

context: Information about the resources in use when the exception was thrown.

HTTP Status Code: 403

InternalServerErrorException

Deadline Cloud can't process your request right now. Try again later.

retryAfterSeconds: The number of seconds a client should wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

context: Information about the resources in use when the exception was thrown.
resourceId: The identifier of the resource that couldn't be found.
resourceType: The type of the resource that couldn't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota.

context: Information about the resources in use when the exception was thrown.
quotaCode: Identifies the quota that is being throttled.
retryAfterSeconds: The number of seconds a client should wait before retrying the request.
serviceCode: Identifies the service that is being throttled.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

context: Information about the resources in use when the exception was thrown.
fieldList: A list of fields that failed validation.
reason: The reason that the request failed validation.

HTTP Status Code: 400