Activity operations#

This section describes the activity operations that are supported by the Cloud Backup API.

List all activity for an agent#

GET /v1.0/{tenant_id}/system/activity/{agentId}

This activity lists all in-progress and completed activity for an agent. Activity types are Backup, Cleanup, and Restore.

This table shows the possible response codes for this operation:

Response Code	Name	Description
200	OK	The request succeeded.
400	Bad Request	There were one or more errors in the request.
401	Unauthorized	The supplied token was not authorized to access the resources. Either it is expired or invalid.
403	Forbidden	Access to the requested resource was denied.
404	Not Found	The backend services did not find anything matching the request URI.
500	Instance Fault	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.
503	Service Unavailable	This is a generic server error. The message contains the reason for the error. This error could wrap several error messages.

Request#

This table shows the URI parameters for the request:

Name	Type	Description
{tenant_id}	String	The unique identifier of the tenant or account.
{agentId}	Integer	The unique identifier for an agent.

This operation does not accept a request body.

Example: List activity for an agent JSON request

GET https://dfw.backup.api.rackspacecloud.com/v1.0/1234/system/activity/232180
User-Agent: controlpanel.drivesrvr.com
Host: dfw.backup.api.rackspacecloud.com
Content-Type: application/json;
Content-Length: 0
X-Auth-Token: 95b1788906f74d279d03001c6a14f3fe

Response#

This table shows the body parameters for the response:

Name	Type	Description
ID	String	Specifies the restore ID, backup ID, or cleanup ID.
Type	String	Specifies type of activity. Valid values are Restore, Backup, or Cleanup.
ParentId	String	Indicates the backup configuration ID for a backup.
DisplayName	String	Indicates the backup name or restore name.
IsBackupConfigurationDeleted	String	Indicates if the backup configuration is deleted. Valid values are true or false.
SourceMachineAgentId	String	Indicates the machine agent ID of the source system.
SourceMachineName	String	Indicates the machine agent name of the source system.
DestinationMachineAgentId	String	Specifies the machine agent ID of the destination system.
DestinationMachineName	String	Indicates name of the destination system.
CurrentState	String	Indicates the current state. Valid values are Creating, Queued, InProgress, Completed, Stopped, Failed, startRequested, Stoprequested, Completed WithErrors, and Preparing.
TimeOfActivity	String	Indicates the time of the activity.
BackupId	String	Specifies the backup ID associated with a restore.

Example: List activity for an agent JSON response

[
     {
         "ID": 137987,
         "Type": "Backup",
         "ParentId": 162423,
         "DisplayName": "Weekly Website Backup",
         "IsBackupConfigurationDeleted": false,
         "SourceMachineAgentId": 232180,
         "SourceMachineName": "Web Server",
         "DestinationMachineAgentId": 0,
         "DestinationMachineName": "",
         "CurrentState": "Completed",
         "TimeOfActivity": "\/Date(1359033934000)\/",
         "BackupId": 134332
     }
  ]

List all activity for a user#

GET /v1.0/{tenant_id}/activity

This operation lists all activity completed or in-progress for the user.