Skip to content
async-operations - v1
/
Retrieve an async operation by ID

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.

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://developer.greenlake.hpe.com/_mock/docs/greenlake/services/compute-ops-mgmt/public/openapi/compute-ops-mgmt-latest/

API endpoint for US West

https://us-west.api.greenlake.hpe.com/

API endpoint for EU Central

https://eu-central.api.greenlake.hpe.com/

API endpoint for AP Northeast

https://ap-northeast.api.greenlake.hpe.com/

accounts - v1beta1

Operations

activation-keys - v1beta1

Operations

activation-tokens - v1beta1

Operations

activities - v1beta2

Operations

ahs-files - v1beta1

Operations

appliance-firmware-bundles - v1

Operations

appliance-firmware-bundles - v1beta1

Operations

approval-policy - v1beta2

Operations

approval-request - v1beta2

Operations

async-operations - v1

Operations

List all async operations

Request

Retrieve a list of async operations for the last 7 days

Security
Bearer
Query
limitinteger[ 0 .. 1000 ]

The maximum number of records to return.

Default 100
Example: limit=10
nextstring(uuid)

The pagination cursor for the next page of resources.

Example: next=b4cf1a6f-1a1f-11ef-9856-20155d97c234
filterstring

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.

CLASSEXAMPLES
Typesinteger, decimal, timestamp, string, boolean, null
Operationseq, ne, gt, ge, lt, le, in
Logicand, 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.

Examples:

Return async operations where a property equals a value. <property> eq <value>

filter=state eq 'FAILED'

Return async operations where a property is less than or equal to a value. <property> le <value>

filter=createdAt le 2024-07-01T17:44:30Z

Return async operations where a property is greater than a value, using url encoding. <property>%20gt%20%27<value>

filter=createdAt%20gt%202024-07-01T17%3A44%3A30Z

Return async operations where a property does not equal a value not <property> eq <value>

filter=not progressPercent eq 100

Return async operations with populated property. not <property> eq null

filter=not error eq null

Return async operations where property contains a value. contains(<property>, <value>)

filter=contains(sourceResourceUri,'groups/3e661d85-eb85-4320-9721-a950d1080641')

Return async operations where property is populated and property contains value. not <property> eq null and contains(<property>, <value>)

filter=not endedAt eq null and contains(sourceResourceUri,'groups/3e661d85-eb85-4320-9721-a950d1080641')

Return async operations where property is one of multiple values. <property> in (<value>,<value>)

filter=generation in (1, 2)
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>'

Responses

OK

Bodyapplication/json
countinteger>= 0required

Number of items returned

Example: 1
nextstring(uuid)required

The pagination cursor for the next page of resources.

Example: "b4cf1a6f-1a1f-11ef-9856-20155d97c234"
totalinteger>= 0required

Total number of items in the collection that match the filter query, if one was provided in the request

Example: 12
itemsArray of objectsrequired
items[].​idstring

Primary identifier for the async operation given by the system

items[].​typestring

Type of the resource

Value "compute-ops-mgmt/async-operation"
items[].​generationinteger>= 1

Monotonically increasing update counter

items[].​createdAtstring(date-time)

Time of async operation creation

items[].​updatedAtstring(date-time)

Time of the last async operation update

items[].​resourceUristring(uri-reference)

URI to the async operation itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1/async-operations/22602690-193a-11ef-b56a-20155d97c234"
items[].​sourceResourceUristring(uri-reference)

URI reference to the resource or resource collection that initiated the async operation

Example: "/compute-ops-mgmt/v1/groups/9ac30e2e-0241-4fd2-aa73-8b1a6f3f5faf/devices"
items[].​statestring(asyncOperationState)

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 last timeoutMinutes.
  • 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.
Enum"INITIALIZED""RUNNING""PAUSED"
Example: "RUNNING"
items[].​startedAtstring(date-time)

Time at which the async operation began

items[].​endedAtstring(date-time)

Time when the async operation reached a terminal state (SUCCEEDED, FAILED, or CANCELLED)

items[].​logMessagesArray of objects(logMessages)

A list of progress update objects which may be empty

items[].​progressPercentinteger[ 0 .. 100 ]

The percent progress of the async operation

items[].​errornull or errorResponse (object)
One of:

There is no data to display when there is no error

null

There is no data to display when there is no error

items[].​recommendationsArray of strings

List of recommendations for resolving the error(s)

Default []
Example: ["Examine the error field for information and retry the operation."]
items[].​resultsArray of objects(asyncOperationResults)

List of references to resources (other than the source resource) which were created, updated, or deleted during the async operation

Response
application/json
{
  "next": "b4cf1a6f-1a1f-11ef-9856-20155d97c234",
  "count": 1,
  "total": 12,
  "items": [
    { … }
  ]
}

Retrieve an async operation by ID

Request

Retrieve a specific async operation by ID for the last 7 days

Security
Bearer
Path
idstring(uuid)required

The ID of the async operation

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>'

Responses

OK

Bodyapplication/json
idstring

Primary identifier for the async operation given by the system

typestring

Type of the resource

Value "compute-ops-mgmt/async-operation"
generationinteger>= 1

Monotonically increasing update counter

createdAtstring(date-time)

Time of async operation creation

updatedAtstring(date-time)

Time of the last async operation update

resourceUristring(uri-reference)

URI to the async operation itself (i.e. a self link)

Example: "/compute-ops-mgmt/v1/async-operations/22602690-193a-11ef-b56a-20155d97c234"
sourceResourceUristring(uri-reference)

URI reference to the resource or resource collection that initiated the async operation

Example: "/compute-ops-mgmt/v1/groups/9ac30e2e-0241-4fd2-aa73-8b1a6f3f5faf/devices"
statestring(asyncOperationState)

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 last timeoutMinutes.
  • 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.
Enum"INITIALIZED""RUNNING""PAUSED"
Example: "RUNNING"
startedAtstring(date-time)

Time at which the async operation began

endedAtstring(date-time)

Time when the async operation reached a terminal state (SUCCEEDED, FAILED, or CANCELLED)

logMessagesArray of objects(logMessages)

A list of progress update objects which may be empty

progressPercentinteger[ 0 .. 100 ]

The percent progress of the async operation

errornull or errorResponse (object)
One of:

There is no data to display when there is no error

null

There is no data to display when there is no error

recommendationsArray of strings

List of recommendations for resolving the error(s)

Default []
Example: ["Examine the error field for information and retry the operation."]
resultsArray of objects(asyncOperationResults)

List of references to resources (other than the source resource) which were created, updated, or deleted during the async operation

Response
application/json
{
  "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": [
    { … }
  ]
}

async-operations - v1beta1

Operations

energy-over-time - v1beta1

Operations

energy-by-entity - v1beta1

Operations

external-services - v1beta1

Operations

filters - v1beta1

Operations

firmware-bundles - v1

Operations

firmware-bundles - v1beta2

Operations

groups - v1

Operations

groups - v1beta3

Operations

groups - v1beta2

Operations

job-templates - v1beta2

Operations

jobs - v1

Operations

jobs - v1beta3

Operations

jobs - v1beta2

Operations

metrics-configurations - v1

Operations

oneview-appliances - v1beta1

Operations

oneview-settings - v1beta1

Operations

oneview-server-templates - v1beta1

Operations

reports - v1beta2

Operations

schedules - v1beta2

Operations

server-locations - v1beta1

Operations

server-settings - v1beta1

Operations

settings - v1

Operations

settings - v1beta1

Operations

servers - v1

Operations

servers - v1beta2

Operations

server-warranty - v1beta2

Operations

user-preferences - v1

Operations

user-preferences - v1beta1

Operations

utilization-over-time - v1beta1

Operations

utilization-by-entity - v1beta1

Operations

webhooks - v1beta1

Operations