Servers

Get the reusable Batch server information

Gets the reusable Batch server information for the specified reusable Batch server.

get/servers/{serverId}

Request

  • Base URL: https://example.com/batch
  • URL: https://example.com/batch/servers/{serverId}
  • Auth: none declared

Path parameters

serverIdstring required

The ID of the reusable Batch server.

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.

contextIdstring

Specifies the context ID that is associated with the reusable Batch server.

hostNamestring

The name of the host on which the reusable Batch server is running.

idstring

Specifies the ID of the reusable Batch server assigned by the Batch service.

isPermanentboolean

Flag indicating whether the reusable Batch server is a permanent server (no idle timeout) or a temporary server (with an idle timeout).

processIdstring

The launcher process ID of the reusable Batch server process.

queueNamestring

The name of the SAS Workload Orchestrator queue that was used when launching the reusable Batch server.

ruleIdstring

Specifies the authorization rule ID that is associated with the reusable Batch server.

runServerAsstring

Specifies the user name under which the reusable Batch server is running.

state'startingForContext' | 'startingForJob' | 'available' | 'availableButCounted' | 'processing' | 'awaitingDeletion' | 'terminated'

The processing state of the reusable Batch server.

versioninteger

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

Example response

{
  "contextId": "16c332b2-4ac6-483b-85f6-7bb9d2d5a576",
  "hostName": "myhost01.mycompany.com",
  "id": "16a46fa5-f866-488d-9cec-92e226bfcf5",
  "isPermanent": true,
  "processId": "5",
  "queueName": "High Priority",
  "ruleId": "16c332b2-4ac6-483b-85f6-7bb9d2d5a576",
  "runServerAs": "myUserName",
  "state": "available"
}

Changes

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