Returns details of a specific async-operation

async-operations

Async Operations API

Operations

Returns a list of async-operations accessible by the user

Request

Returns a list of async-operations that are visible to the user. The response can be paged by using the limit and offset query parameters and filtered and sorted by using the filter and sort query parameters.

Security

bearer

Query

offsetinteger

The offset query parameter should be used in conjunction with limit for paging, e.g.: offset=30&&limit=10. The offset is the number of items from the beginning of the result set to the first item included in the response.

Example: offset=30

limitinteger<= 1000

The limit query parameter should be used in conjunction with offset for paging, e.g.: offset=30&&limit=10. The limit is the maximum number of items to include in the response.

Default 100

Example: limit=10

filterstring

The expression to filter responses.

Example: filter=parent/id eq '73c161c4-4d56-4f31-8dc2-06400a5b36d4'

sortstring

A comma separated list of properties to sort by, followed by a direction indicator ("asc" or "desc"). If no direction indicator is specified the default order is ascending.

Example: sort=id desc,name asc

selectstring

A list of properties to include in the response.

Example: select=id,name

curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services-api/data-services/v1beta1/async-operations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Async Operations list

Bodyapplication/json

itemsArray of objects(Operation)required

items[].idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

items[].typestringread-onlyrequired

The type of resource.

items[].generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].createdAtstring(date-time)required

The time this operation was created.

items[].updatedAtstring(date-time)required

The time this operation was last updated.

items[].resourceUristringread-onlyrequired

The self reference for this resource.

items[].customerIdstringread-onlyrequired

The customer application identifier

items[].namestring

A system specified name for the resource.

items[].additionalDetailsobject

A link to be displayed in the Operations UI. This can be used when a operation is paused to take the user to the console UI page with information on how to unpause the operation, or for more general information when the operation is in other states.

items[].associatedResourcesArray of objects(ResourceReference)

Resources that are associated with the operation. These may be created by the operation or other resources that are involved in the operation.

items[].displayNamestring

The displayed name for the operation.

items[].endedAtstring or null(date-time)

The time this operation completed.

items[].errorobject or null

The error response status of the operation.

items[].estimatedRunningDurationMinutesinteger

An estimate of how long the operation will run before completing.

items[].groupsArray of objects(GroupIDNamePair)

A list of groups associated with this operation.

items[].hasChildOperationsboolean

Indicates this operation possesses child operations. The list of child operations for a given operation may be acquired by querying /data-services/v1beta1/async-operations?filter=parent/id+eq+'{id}' with pagination parameters added as needed to retrieve the full list.

items[].healthStatusstring

The health status indicates if any errors or problems have been encountered during the operation. Expected values are OK, ERROR, WARNING, UNKNOWN, and UNSPECIFIED.

items[].logMessagesArray of objects(OperationLogMessage)

Time stamped messages that record the progress of the operation. The number of messages presented is limited in number and only the most recent messages are included. Some older log messages may therefore be removed to make room for newer messages.

items[].parentobject or null

The parent is the operation that initiated this sub-operation. If this operation is not a sub-operation this will be null.

items[].progressPercentinteger[ 0 .. 100 ]

A percentage representation of progress to completion.

items[].recommendationsArray of objects(OperationRecommendations)

Recommendations on how to fix failing operations.

items[].rootOperationobject or null

The root of the tree of operations. If this operation is not part of a tree this will be null.

items[].servicesArray of strings

List of services this operation belongs to, can be used to filter to specific services in the UI.

items[].sourceResourceUristring or null

The resource that was used to initiate the operation.

items[].startedAtstring or null(date-time)

The time this operation was started.

items[].statestring

A message to indicate the current state of the operation, for example the current step in a workflow. Expected values are INITIALIZED, RUNNING, FAILED, SUCCEEDED, TIMEDOUT, PAUSED, CANCELLED, and UNSPECIFIED.

items[].subtreeOperationCountinteger>= 0

The count of the number of child Operations below this one, recursively.

items[].suggestedPollingIntervalSecondsinteger

This attribute suggests a suitable interval to use when polling for progress. Where specified this will be based on the frequency with which the operation is likely to be updated.

items[].userIdstring

The ID or email address of the user that initiated the operation.

countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

totalinteger

Total number of items matching the filter parameter in the request.

Response

application/json

{
  "items": [
    { … }
  ],
  "count": 0,
  "offset": 0,
  "total": 0
}

Returns details of a specific async-operation

Request

Returns the async-operation with the given id.

Security

bearer

Path

idstring(uuid)required

The UUID of the object

Example: c1a0eb78-41a0-4151-93b2-f057ffeca3f3

Query

selectstring

A list of properties to include in the response.

Example: select=id,name

curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services-api/data-services/v1beta1/async-operations/c1a0eb78-41a0-4151-93b2-f057ffeca3f3 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Single Async Operation

Bodyapplication/json

idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required

The time this operation was created.

updatedAtstring(date-time)required

The time this operation was last updated.

resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

namestring

A system specified name for the resource.

additionalDetailsobject

A link to be displayed in the Operations UI. This can be used when a operation is paused to take the user to the console UI page with information on how to unpause the operation, or for more general information when the operation is in other states.

associatedResourcesArray of objects(ResourceReference)

Resources that are associated with the operation. These may be created by the operation or other resources that are involved in the operation.

displayNamestring

The displayed name for the operation.

endedAtstring or null(date-time)

The time this operation completed.

errorobject or null

The error response status of the operation.

estimatedRunningDurationMinutesinteger

An estimate of how long the operation will run before completing.

groupsArray of objects(GroupIDNamePair)

A list of groups associated with this operation.

hasChildOperationsboolean

Indicates this operation possesses child operations. The list of child operations for a given operation may be acquired by querying /data-services/v1beta1/async-operations?filter=parent/id+eq+'{id}' with pagination parameters added as needed to retrieve the full list.

healthStatusstring

The health status indicates if any errors or problems have been encountered during the operation. Expected values are OK, ERROR, WARNING, UNKNOWN, and UNSPECIFIED.

logMessagesArray of objects(OperationLogMessage)

Time stamped messages that record the progress of the operation. The number of messages presented is limited in number and only the most recent messages are included. Some older log messages may therefore be removed to make room for newer messages.

parentobject or null

The parent is the operation that initiated this sub-operation. If this operation is not a sub-operation this will be null.

progressPercentinteger[ 0 .. 100 ]

A percentage representation of progress to completion.

recommendationsArray of objects(OperationRecommendations)

Recommendations on how to fix failing operations.

rootOperationobject or null

The root of the tree of operations. If this operation is not part of a tree this will be null.

servicesArray of strings

List of services this operation belongs to, can be used to filter to specific services in the UI.

sourceResourceUristring or null

The resource that was used to initiate the operation.

startedAtstring or null(date-time)

The time this operation was started.

statestring

A message to indicate the current state of the operation, for example the current step in a workflow. Expected values are INITIALIZED, RUNNING, FAILED, SUCCEEDED, TIMEDOUT, PAUSED, CANCELLED, and UNSPECIFIED.

subtreeOperationCountinteger>= 0

The count of the number of child Operations below this one, recursively.

suggestedPollingIntervalSecondsinteger

This attribute suggests a suitable interval to use when polling for progress. Where specified this will be based on the frequency with which the operation is likely to be updated.

userIdstring

The ID or email address of the user that initiated the operation.

Response

application/json

{
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "additionalDetails": {
    "consoleUri": "string"
  },
  "associatedResources": [
    { … }
  ],
  "displayName": "string",
  "endedAt": "2019-08-24T14:15:22Z",
  "error": {
    "error": "An example error message.",
    "errorCode": "string",
    "traceId": "f57dcca3345820eb579c9317ce36dd92"
  },
  "estimatedRunningDurationMinutes": 0,
  "groups": [
    { … }
  ],
  "hasChildOperations": true,
  "healthStatus": "string",
  "logMessages": [
    { … }
  ],
  "parent": {
    "name": "string",
    "resourceUri": "string",
    "type": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "progressPercent": 100,
  "recommendations": [
    { … }
  ],
  "rootOperation": {
    "name": "string",
    "resourceUri": "string",
    "type": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "services": [
    "string"
  ],
  "sourceResourceUri": "string",
  "startedAt": "2019-08-24T14:15:22Z",
  "state": "string",
  "subtreeOperationCount": 0,
  "suggestedPollingIntervalSeconds": 0,
  "userId": "string"
}

dual-auth-operations

Dual Authorization API

Operations

issues

Issues API

Operations

secret-assignments

Secret Assignment Management APIs

Operations

secrets

Secret Management APIs

Operations

settings

Settings API

Operations

software-releases

Software Releases

Operations

storage-locations

storage-locations API.

Operations

Data Services API (1.3.0)

async-operations

Returns a list of async-operations accessible by the user

Request

Responses

Was this helpful?

Returns details of a specific async-operation

Request

Responses

Was this helpful?

dual-auth-operations

issues

secret-assignments

secrets

settings

software-releases

storage-locations

tags