Contexts

Get a context

Returns the specified context's information.

get/contexts/{contextId}

Request

  • Base URL: https://example.com/batch
  • URL: https://example.com/batch/contexts/{contextId}
  • Auth: none declared

Path parameters

contextIdstring required

The ID of the context.

Response

The request succeeded.

createdBystring

The username of whoever created the resource.

modifiedBystring

The username of whoever last modified the resource.

creationTimeStampstring date-time

The timestamp for when the resource was created.

modifiedTimeStampstring date-time

The timestamp for when the resource was last modified.

descriptionstring

Specifies the description of the Batch context.

idstring

Specifies the ID of the context assigned by the Batch service.

isMultiServerboolean

Flag indicating that this context is for a reusable Batch server. Allowed in version 3 and later of the context.

launcherContextIdstring

Specifies the ID of the launcher context to use. Required if launcherContextName is not provided.

maxServersinteger

If this is a reusable Batch server, this is the maximum number of servers allowed to run. Allowed in version 3 and later of the context.

minServersinteger

If this is a reusable Batch server, this is the minimum number of servers always running. Allowed in version 3 and later of the context.

namestring

Specifies the name of the Batch context.

providerOptionsstring

Specifies options to pass to SAS Workload Orchestrator. Currently there are no options that can be set.

queueNamestring

Specifies the name of the SAS Workload Orchestrator queue to use if SAS Workload Management is part of the deployment.

runServerAsstring

Specifies the service-account user name to use when working with file sets and processing jobs. Allowed in version 2 and higher of the context.

requiredResourcesstring

Specifies SAS Workload Orchestrator tags that identify on which hosts this job can run if SAS Workload Management is part of the deployment.

sasOptionsstring

Specifies the SAS options to use on the SAS command line.

serverTimeoutinteger

If this is a reusable Batch server, this value is the number of seconds that the server waits for a job before terminating. The default is 300 seconds. Allowed in version 3 and later of the context.

versioninteger

Specifies the version number of this representation schema. This is version 1.

Example response

{
  "description": "Context for High Priority Jobs",
  "id": "e086b29a-2d19-4b97-a912-ee15951e1549",
  "isMultiServer": true,
  "launcherContextId": "9087b3f5-aced-4aa0-a491-b9d33ce197c2",
  "maxServers": 5,
  "minServers": 2,
  "name": "HighPriority",
  "providerOptions": "option1=17",
  "queueName": "High Priority",
  "runServerAs": "serviceAcctUser",
  "requiredResources": "gpuRequired",
  "sasOptions": "-memsize 0",
  "serverTimeout": 900
}

Changes

No recorded changes to this operation across all 1 revision of this API.