REST API task information

Edit online

How to use the REST API to gather information about IBM Storage Archive Enterprise Edition tasks.

Request URLs
/ibmsa/v2/tasks/
/ibmsa/v2/task/list/
/ibmsa/v2/tasks/<id>
/ibmsa/v2/task/show/<id>
Request data
No request data.
Response data
If an <id> is specified, a JSON object that represents the task with that ID is returned. If no <id> is specified, an array of JSON objects is returned.

By default, the array contains the most current (newly created) tasks, up to 1000 tasks, including both active and completed tasks. The array is in descending order, based on the time the task was created (created_time).

Each JSON object has the following fields:
id: <string>
The task ID. Because the task ID is overwritten after the task ID reaches the upper limit, the ID is in the format of <task_id>@<created_time>.
task_id: <number>
The same value as the corresponding IBM Storage Scale task ID.
type: <string>
The task type that matches the eeadm command or the transparent recall.
cmd_param: <string>
The eeadm command input from the user. If the type is transparent_recall, the field is empty.
result: <string>
The result for completed tasks. The <string> can contain status information, or be empty. If the <string> is empty, the task did not complete. For more information, see eeadm task list command output.
status: <string>
The status for the task. The <string> can contain status information, or it can be empty. If the <string> is empty, an internal error occurred. For more information, see eeadm task list command output.
inuse_libs: <string array>
The libraries that the task is currently using. The value is a <string array> of library.name.
inuse_node_groups: <string array>
The node groups that the task is currently using. The value is a <string array> of nodegroup.name .
inuse_drives: <string array>
The drives that the task is currently using. The value is a <string array> of drive.id .
inuse_pools: <string array>
The pools that the task is currently using. The value is a <string array> of pool.name .
inuse_tapes: <string array>
The tapes that the task is currently using. The value is a <string array> of tape.barcode.
created_time: <string>
The UTC time that the task was accepted by the MMM.

All timestamp values are returned in the following format, in UTC: <yyyy>-<MM>-<dd>T<HH>:<mm>:<ss>.<SSS>Z

started_time: <string>
The UTC time that the task was started.
completed_time: <string>
The UTC time that the MMM determined the task to be complete.
recall_inode: <number>
The GPFS inode number of the recalled file. Only available for transparent recall tasks.
recall_filename: <string>
The file name of the recalled file with the full path. Only available for transparent recall tasks.
file_amount: <number>
The amount of bytes processed by the task. Available for migrate, premigrate, selective recall, transparent recall, and save tasks.
file_count: <number>
The number of files processed by the task. Available for migrate, premigrate, selective recall, transparent recall, and save tasks.
Filtering parameters
start-created-time: <string>
Filters out the tasks where the created_time is earlier than this parameter.
end-created-time: <string>
Filters out the tasks where the created_time is later than this parameter.
type: <string>
Filters the list of tasks by the task type.
result: <string>
Filters the list of tasks by the task result.
status: <string>
Filters the list of tasks by the task status.
completed-only
Filters the list of tasks by only tasks with completed status. This parameter is not compatible with the status parameter.
all
Retrieves all of the tasks with the indicated status, if no status is indicated it will retrieve both completed and active tasks.
num-tasks: <int>
Limits the number of tasks to get. This parameter is not compatible with the all parameter. By default the list will only include the last 1000 tasks.