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

GetQueueEnvironment

Gets a queue environment.

Request Syntax


GET /2023-10-12/farms/farmId/queues/queueId/environments/queueEnvironmentId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

farmId

The farm ID for the queue environment.

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

Required: Yes

queueEnvironmentId

The queue environment ID.

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

Required: Yes

queueId

The queue ID for the queue environment.

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "createdBy": "string",
   "name": "string",
   "priority": number,
   "queueEnvironmentId": "string",
   "template": "string",
   "templateType": "string",
   "updatedAt": "string",
   "updatedBy": "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.

createdAt

The date and time the resource was created.

Type: Timestamp

createdBy

The user or system that created this resource.>

Type: String

name

The name of the queue environment.

Type: String

priority

The priority of the queue environment.

Type: Integer

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

queueEnvironmentId

The queue environment ID.

Type: String

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

template

The template for the queue environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 15000.

templateType

The type of template for the queue environment.

Type: String

Valid Values: JSON | YAML

updatedAt

The date and time the resource was updated.

Type: Timestamp

updatedBy

The user or system that updated this resource.

Type: String

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