Fetching workloads
You can obtain a list of workloads that are present in Acronis Cyber Protect Cloud by sending a GET
request to the /api/workload_management/v5/workloads
endpoint.
Request structure
Parameter |
Type |
Description |
---|---|---|
|
string |
|
|
string |
|
|
string |
|
|
string |
|
|
string |
|
|
boolean |
If true, includes workload statuses in the response. Does not include workload statuses otherwise. |
|
boolean |
If true, includes all workload attributes in the response. Does not include workload attributes otherwise. Mutually exclusive with the |
|
array of string |
Includes the specified workload attributes (if present) by their names in the response. Mutually exclusive with the |
|
boolean |
If true, includes allowed actions for the workload in the response. Does not include workload actions otherwise. |
|
boolean |
If true, includes aspects that were aggregated into the workload. |
|
string |
|
|
integer |
Number of the results returned in the response. |
|
string |
Cursor to the previous results page. |
|
string |
Cursor to the next results page. |
Response structure
If the workloads were fetched successfully, the response returns status 200, with the payload in the following structure:
Parameter |
Type |
Description |
---|---|---|
|
array of object |
A list of workloads. |
|
string |
The UUID of the workload. |
|
string |
The identifier of the workload type. |
|
string |
A name of the workload. |
|
object |
A key-value map of workload attributes. Allowed values are defined by the attributes schema specified in the Vendor Portal. |
|
string |
An identifier of the API client that created the workload. Must be the client ID of your application. |
|
array of string |
A list of workload action identifiers that are allowed for this workload. |
|
string |
The identifier of the tenant where the workload was created. |
|
string |
The identifier that is used in the external system where the workload is originated from. Equal to the |
|
string |
UUID of the agent that manages the workload. Only applicable to Acronis workloads. |
|
string |
RFC3339 date and time in UTC timezone when the workload was created. |
|
string |
RFC3339 date and time in UTC timezone when the workload was updated. |
|
object |
Parameters of any use cases when workload group is automatically created. |
|
array of objects |
Parameters of any use cases when the parent-child relationship is set automatically. |
|
boolean |
True if the workload was created due to merge and cluster-like use case. False otherwise. |
|
string |
|
|
boolean |
Status of the workload. True if enabled, false otherwise. |
|
object |
An object containing the information about the pagination. |
|
object |
An object containing the information about the cursors to the pages. |
|
string |
Cursor to the next page. |
|
string |
Cursor to the previous page. |
|
array of object |
A list of links related to the requested resource. |