Versions Compared

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

taskName

Storage Provider

Name

Description

Request Body

Response Body

enable-streaming

Amazon S3

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

Amazon S3

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

Amazon S3

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

run-hadoop-job

Amazon S3

Run Hadoop Job task

Runs a hadoop job using Amazon's Elastic Map Reduce feature. A JAR which implements the hadoop interfaces is expected to have already been loaded into S3. This JAR is used to execute the hadoop job.

A map serialized into XML which includes, at a minimum, values for jarContentId, sourceSpaceId, destSpaceId, and workSpaceId.

A map serialized into XML which includes the jobFlowId

describe-hadoop-job

Amazon S3

Describe Hadoop Job task

Retrieves information about a hadoop job running in Amazon's Elastic Map Reduce

The Job Flow ID

A map serialized into XML which includes information about the running job

stop-hadoop-job

Amazon S3

Stop Hadoop Job task

Stops a hadoop job running in Amazon's Elastic Map Reduce

The Job Flow ID

A map serialized into XML which includes a results key with a value of either success or failure

noop

Amazon S3

Test task

Provides a simple way to test the calling of tasks

Body content is ignored

Text indicating successful task completion

restore-contentAmazon GlacierRestore 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.)

...