Data Transfer Rate Controller Resource

The API allows you to list, view, edit and create application users.

GET /data-transfer-rates

Get the list of aggregated transfer rates for a specific domains

Request Parameters
name type description default constraints multivalued
aggregation-guid query     yes
aggregation-type query TASK "ARCHIVED_TASK" or "BACKUP_DESTINATION" or "NODE" or "SOURCE" or "SYSTEM" or "TASK" or "WORKFLOW_EXECUTION" no
archived-task query     no
backup query     no
backup-destination query     no
direction query     no
filter query     no
from query   long no
nameLike query     no
node query     no
orderBy query     no
page query     no
size query     no
time-aggregation-type query   "DAY" or "FIVE_MINUTES" or "HOUR" or "MERGED" or "MINUTE" no
to query   long no
workflow-execution query     no
Response Body
media type data type description
application/json array of DataTransferRateListRecord (JSON) a single user details

Example

Request
GET /data-transfer-rates
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

GET /data-transfer-rates/aggregated

Request Parameters
name type description default constraints
backup-guid query   required
bucket-count query 100 max: 1000, min: 0
Response Body
media type data type description
application/json array of object (JSON)

Example

Request
GET /data-transfer-rates/aggregated
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /data-transfer-rates/report

Get a singular aggregated transfer rate result for a specific domain

Request Parameters
name type description default constraints multivalued
aggregation-guid query     yes
aggregation-type query ARCHIVED_TASK "ARCHIVED_TASK" or "BACKUP_DESTINATION" or "NODE" or "SOURCE" or "SYSTEM" or "TASK" or "WORKFLOW_EXECUTION" no
app-cmd-exec-config query     no
archived-task query     no
backup-destination query     no
cloud-service-provider query     no
direction query     no
filter query     no
from query   long no
hypervisor query     no
hypervisor-manager query     no
nameLike query     no
node query     no
orderBy query     no
page query     no
size query     no
storage-provider query     no
task query     no
task-type query   "BACKUP_CLEANUP" or "BACKUP_DESTINATION_INIT" or "BACKUP_DESTINATION_SYNC" or "CONNECTIVITY_TEST" or "DELETE" or "EJECT_TAPE" or "EXPORT" or "IMPORT" or "IMPORT_TAPE" or "INVENTORY_SYNC" or "LIVE_MIGRATION" or "MOUNT" or "RESTORE" or "SCOPED_INVENTORY_SYNC" or "SNAPSHOT" or "SNAPSHOT_CLEANUP" or "SNAPSHOT_REVERSION" or "STAGING_CLEANUP" or "STORE" or "TAPE_MANAGER_INVENTORY_SYNC" or "UNMOUNT" or "UPLOAD" yes
time-aggregation-type query MERGED "DAY" or "FIVE_MINUTES" or "HOUR" or "MERGED" or "MINUTE" no
to query   long no
unit query MEGABYTE "BYTE" or "GIGABYTE" or "KILOBYTE" or "MEGABYTE" or "PETABYTE" or "TERABYTE" no
workflow-execution query     no
Response Body
media type data type description
application/json array of AggregatedDataTransferRateListRecord (JSON) a single user details

Example

Request
GET /data-transfer-rates/report
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]