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

GetStorageProfileForQueue

Gets a storage profile for a queue.

Request Syntax


GET /2023-10-12/farms/farmId/queues/queueId/storage-profiles/storageProfileId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

farmId

The farm ID for the queue in storage profile.

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

Required: Yes

queueId

The queue ID the queue in the storage profile.

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

Required: Yes

storageProfileId

The storage profile ID for the storage profile in the queue.

Pattern: sp-[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

{
   "displayName": "string",
   "fileSystemLocations": [ 
      { 
         "name": "string",
         "path": "string",
         "type": "string"
      }
   ],
   "osFamily": "string",
   "storageProfileId": "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.

displayName

The display name of the storage profile connected to a queue.

Important

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Type: String

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

fileSystemLocations

The location of the files for the storage profile within the queue.

Type: Array of FileSystemLocation objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

osFamily

The operating system of the storage profile in the queue.

Type: String

Valid Values: WINDOWS | LINUX | MACOS

storageProfileId

The storage profile ID.

Type: String

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

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