Versions Compared

Old Version 63

changes.mady.by.user Bill Branan

Saved on

compared with

New Version 64

changes.mady.by.user Bill Branan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titleTask REST Methods
Info

Tasks are used to perform storage provider actions which cannot be performed in a generic manner across multiple providers.

Get Tasks

  • Purpose: Provides a listing of all of the supported tasks for a given provider. Note that if no storeID parameter is included, the task listing is provided for the primary storage provider.
  • Request: GET https://host:port/durastore/task ? (storeID)
  • Response Code: 200 (on success)

  • Response Body: XML similar to:

    Code Block
    languagehtml/xml
    <list>
  <string>task1</string>
  <string>task2</string>
</list>

Perform Task

  • Purpose: Performs a particular task. Note that most tasks can be performed by only one storage provider type.
  • Request: POST https://host:port/durastore/task/taskName ? (storeID)
  • Request Body: Parameters for task. Each task will expect parameters in a specific format, see task listing for more details.
  • Response Code: 200 (on success)
  • Response Body: Response value for task, format varies by task.

Tasks

Amazon S3 Storage Provider

taskName

Name

Description

Request Body

Response Body

enable-streaming

Enable Streaming task

Enables RTMP streaming for all files within a DuraCloud space through the use of Amazon's Cloudfront streaming capability. This task may take up to 15 minutes to complete.

Name of the space for which streaming is to be enabled

Text indicating the results of the task, including the streaming host

disable-streaming

Disable Streaming task

Disables streaming by removing the ability for Cloudfront to access files within a space. This does not remove the streaming distribution, only disables its use, so enabling streaming on the same space again can be performed much more quickly. Some content in the space may continue to be available for streaming up to 24 hours after streaming has been disabled.

Name of the space for which streaming is to be disabled

Text indicating the results of the task

delete-streaming

Delete Streaming task

Removes a streaming distribution created by the enable-streaming task. This task should be performed after performing the disable-streaming task. This task may take up to 15 minutes to complete, after which no content in the space will be available for streaming.

Name of the space for which streaming is to be deleted

Text indicating the results of the task

noop

Test task

Provides a simple way to test the calling of tasks

Body content is ignored

Text indicating successful task completion

Amazon Glacier Storage Provider

taskName

Name

Description

Request Body

Response Body
restore-contentRestore Content taskProvides the capability to request that specific content items stored in Glacier be retrieved. Content items which are retrieved are made available 3-5 hours after this request is made, and remains available for 2 weeks.Name of the space and the content item in the form: spaceID/contentIDText indicating that a restore action has been initiated (or that a restore is already in progress, in the case of duplicate requests.)
Snapshot Storage Provider

taskName

Name

Description

Request Body

Response Body
create-snapshotCreate Snapshot taskCreates a snapshot by collecting details of the snapshot and passing the request down to a bridge application which makes a copy of the contents of the space.
Code Block
{
  "spaceId" : ""
  "description" : ""
  "userEmail" : ""
}

tttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttt

Code Block
{
  "snapshotId" : ""
}

tttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttt

 

get-snapshot-statusGet Snapshot Status taskRetrieves the status of a snapshot action  
complete-snapshotComplete Snapshot taskEnds the process of snapshot creating, allowing the content items included in the snapshot to be removed  
get-snapshotsGet List of Snapshots taskRetrieves a listing of all snapshots which have been created  
get-snapshot-contentsGet List of Snapshot Contents taskRetrieves a listing of the contents of a particular snapshot  
restore-snapshotRestore Snapshot taskRequests that a snapshot be restored to a DuraCloud space  
get-restore-statusGet Snapshot Restore StatusRetrieves the status of a restore action  

...