Cloud Management API 1.5

Tasks

Tasks represent processes that happen (or have happened) asynchronously within the context of an Instance.

An example of a type of task is an operational script that runs in an instance.

Task resources can be returned by certain API calls, such as Instances.run_executable, Backups.restore, and others.

Actions

show

Displays information of a given task within the context of an instance.

URLs
GET /api/clouds/:cloud_id/instances/:instance_id/live/tasks/:id
GET /api/server_arrays/:server_array_id/live/tasks/:id
HTTP response code
200 OK
Content-type
application/vnd.rightscale.task

Required roles

Parameters

name required type values regexp blank? description
view no String default, extended * no Specifies how many attributes and/or expanded nested relationships to include.

Example Responses

Click on a format below to see an example response for the 'default' view:

JSON XML
{
  "links": [
    {"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2308670741;RAND/live/tasks/ae-9"}
  ],
  "actions": [

  ],
  "summary": "test summary"
}
<?xml version="1.0" encoding="UTF-8"?>
<task>
  <links>
    <link rel="self" href="/api/clouds/888/instances/RESOURCE_2308670741;RAND/live/tasks/ae-9"/>
  </links>
  <actions/>
  <summary>test summary</summary>
</task>

Click on a format below to see an example response for the 'extended' view:

JSON XML
{
  "links": [
    {"rel":"self","href":"/api/clouds/888/instances/RESOURCE_2308670741;RAND/live/tasks/ae-9"}
  ],
  "actions": [

  ],
  "summary": "test summary",
  "detail": "detail_2474168019"
}
<?xml version="1.0" encoding="UTF-8"?>
<task>
  <links>
    <link rel="self" href="/api/clouds/888/instances/RESOURCE_2308670741;RAND/live/tasks/ae-9"/>
  </links>
  <actions/>
  <summary>test summary</summary>
  <detail>detail_2474168019</detail>
</task>