Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Get Task

GET /vdc/data-stores/{id}/tasks/{op_id}/

Get a specific task for a specific data store.

idIdentifier for the data store to query
op_idIdentifier for the task operation of the data store

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • SYSTEM_MONITOR


Response Body

Task representation

This is an asychronous operation that returns a task object. For information on working with tasks, see Asynchronous Operations.

Field Description Type Notes
task
op_id The task operation id String
resource    
name The name of the resource String
id ECS Id of the related object URI
link Hyperlink to the related object
tenant    
id ECS Id of the related object URI
link Hyperlink to the related object
associated_resources A list of links for associated resources
associated_resource     0-* Elements
name The name of the resource String
id ECS Id of the related object URI
link Hyperlink to the related object
state The state of the task String Valid Values:
  •  pending = task is pending
  •  ready = task succeed
  •  error = task fails
message The task detail message String
description The description of the task String
service_error    
code The numerical code associated with the error encountered when processing a service request Integer
description The description of the error String
details Detailed information concerning the error String
retryable Indicates whether the error is retryable which means service is temporarily unavailable and the client could retry after a while. Boolean Valid Values:
  •  true = it is retryable.
  •  false = it is not retryable.
start_time The date and time of when the task was started DateTime
end_time The date and time of when the task ended DateTime
progress Integer
workflow    
id ECS Id of the related object URI
link Hyperlink to the related object
name Name assigned to this resource in ECS. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
id Identifier that is generated by ECS when the resource is created. The resource Id is guaranteed to be unique and immutable across all virtual data centers for all time. URI Valid Values:
  •  urn:storageos:resource-type:UUID:
link Hyperlink to the details for this resource
creation_time Timestamp that shows when this resource was created in ECS DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
  •  Unix timestamp
inactive Indicates whether the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ECS database. Boolean Valid Values:
  •  true
  •  false
global Indicates whether the resource is global. Boolean Valid Values:
  •  true
  •  false
remote Indicates whether the resource is remote. Boolean Valid Values:
  •  true
  •  false
vdc    
id ECS Id of the related object URI
link Hyperlink to the related object
internal Indicated whether the resource is an internal resource Boolean Valid Values:
  •  true
  •  false