Retrieve a list of async operations for the last 7 days
HPE Compute Ops Management API (latest)
HPE Compute Operations Management provides a Restful API to customers who want to manage their devices programmatically or through a command line. The API enables customers to invoke operations or tasks such as list devices, see device details, device health, and manage their device's firmware.
UPDATED API ENDPOINTS
Compute Ops Management now supports the HPE GreenLake API endpoints (<region>.api.greenlake.hpe.com
). The Guide contains more information about this change.
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/
https://us-west.api.greenlake.hpe.com/
https://eu-central.api.greenlake.hpe.com/
https://ap-northeast.api.greenlake.hpe.com/
The pagination cursor for the next page of resources.
Limit the resources operated on by an endpoint or when used with a multiple-GET endpoint, return only the subset of resources that match the filter. The filter grammar is a subset of OData 4.0.
NOTE: The filter query parameter must use URL encoding. Most clients do this automatically with inputs provided to them specifically as query parameters. Encoding must be done manually for any query parameters provided as part of the URL.
The reserved characters !
#
$
&
'
(
)
*
+
,
/
:
;
=
?
@
[
]
must be encoded with percent encoded equivalents. Server IDs contain a +
, which must be encoded as %2B
.
For example: the value P06760-B21+2M212504P8
must be encoded as P06760-B21%2B2M212504P8
when it is used in a query parameter.
CLASS | EXAMPLES |
---|---|
Types | integer, decimal, timestamp, string, boolean, null |
Operations | eq, ne, gt, ge, lt, le, in |
Logic | and, or, not |
Async Operations can be filtered by:
- createdAt
- endedAt
- error
- generation
- id
- logMessages
- progressPercent
- recommendations
- results
- sourceResourceUri
- startedAt
- state
- updatedAt
The following examples are not an exhaustive list of all possible filtering options.
Return async operations where a property equals a value. <property> eq <value>
Return async operations where a property is less than or equal to a value. <property> le <value>
Return async operations where a property is greater than a value, using url encoding. <property>%20gt%20%27<value>
Return async operations where a property does not equal a value not <property> eq <value>
Return async operations with populated property. not <property> eq null
Return async operations where property contains a value. contains(<property>, <value>)
Return async operations where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)
Return async operations where property is one of multiple values. <property> in (<value>,<value>)
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/async-operations
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/async-operations
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1/async-operations
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1/async-operations
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X GET \
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/async-operations \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
OK
The pagination cursor for the next page of resources.
Total number of items in the collection that match the filter query, if one was provided in the request
URI to the async operation itself (i.e. a self link)
URI reference to the resource or resource collection that initiated the async operation
The current state of an async operation. This value is controlled by Compute Ops Management and is read-only for the user.
INITIALIZED
- Active, not terminal. The async operation has been created and is waiting to be started.RUNNING
- Active, not terminal. The async operation is running.PAUSED
- Active, not terminal. The async operation has been paused by the system and requires user input.TIMEDOUT
- Inactive, not terminal. The async operation did not receive an update in the lasttimeoutMinutes
.SUCCEEDED
- Inactive, terminal. The async operation is complete and succeeded.FAILED
- Inactive, terminal. The async operation is complete and failed.CANCELLED
- Inactive, terminal. The async operation was cancelled.
Time when the async operation reached a terminal state (SUCCEEDED
, FAILED
, or CANCELLED
)
A list of progress update objects which may be empty
There is no data to display when there is no error
There is no data to display when there is no error
List of recommendations for resolving the error(s)
{ "next": "b4cf1a6f-1a1f-11ef-9856-20155d97c234", "count": 1, "total": 12, "items": [ { … } ] }
- Mock server
https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/async-operations/{id}
- API endpoint for US West
https://us-west.api.greenlake.hpe.com/compute-ops-mgmt/v1/async-operations/{id}
- API endpoint for EU Central
https://eu-central.api.greenlake.hpe.com/compute-ops-mgmt/v1/async-operations/{id}
- API endpoint for AP Northeast
https://ap-northeast.api.greenlake.hpe.com/compute-ops-mgmt/v1/async-operations/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- Go
- C#
- PHP
curl -i -X GET \
'https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/compute-ops-mgmt/v1/async-operations/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
OK
URI to the async operation itself (i.e. a self link)
URI reference to the resource or resource collection that initiated the async operation
The current state of an async operation. This value is controlled by Compute Ops Management and is read-only for the user.
INITIALIZED
- Active, not terminal. The async operation has been created and is waiting to be started.RUNNING
- Active, not terminal. The async operation is running.PAUSED
- Active, not terminal. The async operation has been paused by the system and requires user input.TIMEDOUT
- Inactive, not terminal. The async operation did not receive an update in the lasttimeoutMinutes
.SUCCEEDED
- Inactive, terminal. The async operation is complete and succeeded.FAILED
- Inactive, terminal. The async operation is complete and failed.CANCELLED
- Inactive, terminal. The async operation was cancelled.
Time when the async operation reached a terminal state (SUCCEEDED
, FAILED
, or CANCELLED
)
There is no data to display when there is no error
There is no data to display when there is no error
List of recommendations for resolving the error(s)
{ "id": "string", "type": "compute-ops-mgmt/async-operation", "generation": 1, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "resourceUri": "/compute-ops-mgmt/v1/async-operations/22602690-193a-11ef-b56a-20155d97c234", "sourceResourceUri": "/compute-ops-mgmt/v1/groups/9ac30e2e-0241-4fd2-aa73-8b1a6f3f5faf/devices", "state": "INITIALIZED", "startedAt": "2019-08-24T14:15:22Z", "endedAt": "2019-08-24T14:15:22Z", "logMessages": [ { … } ], "progressPercent": 100, "error": {}, "recommendations": [ "Examine the error field for information and retry the operation." ], "results": [ { … } ] }