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

GetStorageProfile

Gets a storage profile.

Request Syntax


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

URI Request Parameters

The request uses the following URI parameters.

farmId

The farm ID for the storage profile.

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

Required: Yes

storageProfileId

The storage profile ID.

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

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

displayName

The display name of the storage profile.

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.

Type: Array of FileSystemLocation objects

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

osFamily

The operating system (OS) for the storage profile.

Type: String

Valid Values: WINDOWS | LINUX | MACOS

storageProfileId

The storage profile ID.

Type: String

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

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.

HTTP Status Code: 403

InternalServerErrorException

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

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota.

HTTP Status Code: 429

ValidationException

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

HTTP Status Code: 400