IRPCBackgroundOperationsAdmin.GetAsyncTask
Administration API / specialized admin session idempotent
Gets one asynchronous task by ID.
| Service | Background operations MFiles.IRPCBackgroundOperationsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCBackgroundOperationsAdmin/GetAsyncTask |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-async-task |
| Request | GetAsyncTaskRequest |
| Response | GetAsyncTaskResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires a vault session and the vault right
change_metadata_structure. - An unknown ID fails with "Not found. <id>" (0x800408A4).
Request: GetAsyncTaskRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
async_task | int64 | The ID of the task. |
Response: GetAsyncTaskResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
async_task | AsyncTask | The task. |
async_task.id | int64 | Task ID. |
async_task.type | string | Task type name. |
async_task.definition | string | The display string of the task definition. |
async_task.is_running | bool | True if the task is currently running. |
async_task.last_run_started_utc | google.protobuf.Timestamp | The last time the task ran started. Zero to indicate that the task has never run (or is still running for the first time). |
async_task.last_run_ended_utc | google.protobuf.Timestamp | The last time the task ran ended. Zero to indicate that the task has never run (or is still running for the first time). |
async_task.last_run_succeeded | bool | True if the last run was successful, false otherwise. |
async_task.last_run_errors | string | Error string from the last run (if any). |
async_task.canceled | bool | True if the task is canceled. |
async_task.progress_info | string | The progress info string of the task. |
async_task.output_info | string | The output info string of the task. |