Workloads

get
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads
List Workloads
post
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads
Create Workload
Body format
Workload create requires a Body in json format, to provide the requested information.
Using a policy-id will pull the following information from the policy. Values provided in the Body will be overwritten with the values from the Policy.
1
retention_policy_type
2
retention_policy_value
3
interval
Copied!
1
{
2
   "workload":{
3
      "name":"<name of the Workload>",
4
      "description":"<description of workload>",
5
      "workload_type_id":"<ID of the chosen Workload Type",
6
      "source_platform":"openstack",
7
      "instances":[
8
         {
9
            "instance-id":"<Instance ID>"
10
         },
11
         {
12
            "instance-id":"<Instance ID>"
13
         }
14
      ],
15
      "jobschedule":{
16
         "retention_policy_type":"<'Number of Snapshots to Keep'/'Number of days to retain Snapshots'>",
17
         "retention_policy_value":"<Integer>"
18
         "timezone":"<timezone>",
19
         "start_date":"<Date format: MM/DD/YYYY>"
20
         "end_date":"<Date format MM/DD/YYYY>",
21
         "start_time":"<Time format: HH:MM AM/PM>",
22
         "interval":"<Format: Integer hr",
23
         "enabled":"<True/False>"
24
      },
25
      "metadata":{
26
         <key>:<value>,
27
         "policy_id":"<policy_id>"
28
      }
29
   }
30
}
Copied!
get
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads/<workload_id>
Show Workload
put
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads/<workload_id>
Modify Workload
Body format
Workload modify requires a Body in json format, to provide the information about the values to modify.
All values in the body are optional.
Using a policy-id will pull the following information from the policy. Values provided in the Body will be overwritten with the values from the Policy.
1
retention_policy_type
2
retention_policy_value
3
interval
Copied!
1
{
2
   "workload":{
3
      "name":"<name>",
4
      "description":"<description>"
5
      "instances":[
6
         {
7
            "instance-id":"<instance_id>"
8
         },
9
         {
10
            "instance-id":"<instance_id>"
11
         }
12
      ],
13
      "jobschedule":{
14
         "retention_policy_type":"<'Number of Snapshots to Keep'/'Number of days to retain Snapshots'>",
15
         "retention_policy_value":"<Integer>",
16
         "timezone":"<timezone>",
17
         "start_time":"<HH:MM AM/PM>",
18
         "end_date":"<MM/DD/YYYY>",
19
         "interval":"<Integer hr>",
20
         "enabled":"<True/False>"
21
      },
22
      "metadata":{
23
         "meta":"data",
24
         "policy_id":"<policy_id>"
25
      },
26
   }
27
}
Copied!
delete
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads/<workload_id>
Delete Workload
post
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads/<workload_id>/unlock
Unlock Workload
post
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads/<workload_id>/reset
Reset Workload