GetTaskDetails
Retrieves details about a selected and authorized task. The API returns full monitoring information related to the selected task.
Required User Role: See Required Enterprise Manager permissions.
Syntax
public AemGetTaskDetailsResp GetTaskDetails(
string server,
string task
);
Parameters
Parameter | Type | Description |
---|---|---|
server | string | The name of the server. |
task | string |
|
Return values for Replicate tasks
AemGetTaskDetailsResp
Value | Type | Description |
---|---|---|
Task |
AemTaskInfoDetailed | - |
Type |
string |
The task type: AemTaskInfoDetailed |
Name |
string |
The name of the task. |
Description |
string |
The task description. If there is no description, an empty string will be returned. |
CdcEventCounters |
AemTaskCdcEventCounters |
All numeric data concerning CDC events. |
AppliedDdlCount |
long |
The total number of metadata changes, such as add column. |
AppliedDeleteCount |
long |
The number of records deleted in total for all tables. |
AppliedInsertCount |
long |
The number of records added in total for all tables. |
AppliedUpdateCount |
long |
The number of records updated in total for all tables. |
CdcLatency |
AemCdcLatency | CDC latency information. |
SourceLatency |
string |
The time gap between the original change in the source endpoint and capturing it, in hh:mm:ss. |
TotalLatency |
string |
The overall latency (source latency + target latency + apply latency), in hh:mm:ss. |
CdcThroughput |
AemCdcThroughput |
Indicates how fast the table records are being replicated to the target endpoint (by number or volume of records). Refers only to the current/last CDC. |
SourceThroughputRecordsCount |
AemCdcThroughputItem |
The current source throughput, in rec/sec. |
SourceThroughputVolume |
AemCdcThroughputItem |
The current source throughput, in kbyte/sec. |
TargetThroughputRecordsCount |
AemCdcThroughputItem |
The current target throughput, in rec/sec. |
TargetThroughputVolume |
AemCdcThroughputItem |
The current target throughput, in kbyte/sec |
Current |
long |
- |
CdcTransactionsCounters |
AemCdcTransactionsCounters |
All numeric data concerning CDC transactions. |
AppliedComittedTransactionCount |
long |
The number of transactions committed. |
AppliedRecordsComittedCount |
long |
The sum of all records/events in all Completed transactions. |
AppliedRecordsInProgressCount |
long |
The sum of all records/events in all In-Progress transactions. |
AppliedTransactionsInProgressCount |
long |
The number of transactions in progress. |
AppliedVolumeComittedMb |
long |
The sum of all volume/events in all Completed transactions, in MB. |
CommitChangeRecordsCount |
long |
The number of COMMIT change records. |
IncomingAccumulatedChangesOnDiskCount |
long |
The number of changes accumulated on disk until source commit. |
IncomingAccumulatedChangesInMemoryCount |
long |
The number of changes accumulated in memory until source commit. |
IncomingApplyingChangesInMemoryCount |
long |
The number of changes in memory during apply and until target commit. |
IncomingApplyingChangesOnDiskCount |
long |
The number of changes on disk during apply and until target commit. |
RollbackChangeRecordsCount |
long |
The number of ROLLBACK change records. |
RollbackChangeVolumeMb |
long |
The volume of ROLLBACK changes, in MB. |
RollbackTransactionCount |
long |
The number of changes in memory during apply and until target commit. |
FullLoadCompleted |
bool |
- |
FullLoadCounters |
AemTaskFullLoadCounters |
All numeric data concerning Full Load events. |
EstimatedRecordsForAllTablesCount |
long |
The estimated number of records remaining to be loaded into the target endpoint. |
RecordsCompletedCount |
long |
The total number of records that have completed loading into the target endpoint. |
TablesCompletedCount |
int |
The number of tables that have been loaded into the target endpoint. |
TablesLoadingCount |
int |
The number of tables that are currently being loaded into the target endpoint. |
TablesQueuedCount |
int |
The number of tables that are waiting to be loaded due to an error. |
TablesWithErrorCount |
int |
The number of tables that could not be loaded due to an error. |
FullLoadEnd |
string |
Indicates whether the full load process has ended. |
FullLoadStart |
string |
The start time of the full load process. Format: YYY MM DD Timezone: UTC |
FullLoadThroughput |
AemFullLoadThroughput |
- |
SourceThroughputRecordsCount |
int |
The current source throughput, in rec/sec. |
SourceThroughputVolume |
int |
The current source throughput, in kbyte/sec. |
TargetThroughputRecordsCount |
int |
The current target throughput, in rec/sec. |
TargetThroughputVolume |
int |
The current target throughput, in kbyte/sec. |
MemoryMb |
long |
The current utilization of memory, in MB. A task's memory utilization is sampled every 10 seconds. When the task is not running, the value is set to zero (0). |
CpuPercentage |
- |
The current CPU usage of the Replicate task process. Information note
Only available for Replicate tasks running on Replicate 6.2 and above. When not available, this parameter will be returned as -1. |
DiskUsageMb |
long |
The current utilization of disk space, in MB. A task's disk utilization is sampled every minute. |
DataErrorCount |
long |
The total number of data errors in all tables involved in the task. The count is affected by data errors and the Reset Data Errors option available when you drill down to a task. |
Options |
AemCommonSettings |
- |
ApplyChangesEnabled |
bool |
See Task Options. |
AuditChangesEnabled |
bool |
See Task Options. |
FullLoadEnabled |
bool |
See Task Options. |
StoreChangesEnabled |
bool |
See Task Options. |
Profile |
string |
See Profile Parameters. |
SourceEndpoint |
TaskEndpoint |
- |
Name |
string |
The name of the source endpoint. |
Type |
string |
The source endpoint type. |
TargetEndpoint |
TaskEndpoint |
- |
Name |
string |
The name of the target endpoint. |
Type |
string |
The target endpoint type. |
State |
AemTaskState { STOPPED = 0, RUNNING = 1, ERROR = 2, RECOVERY = 3 } |
The current state of the task. |
TaskStopReason |
AemTaskStopReason { NONE = 0, NORMAL = 1, RECOVERABLE_ERROR = 2, FATAL_ERROR = 3, FULL_LOAD_ONLY_FINISHED = 4, STOPPED_AFTER_FULL_LOAD = 5, STOPPED_AFTER_CACHED_EVENTS = 6, EXPRESS_LICENSE_LIMITS_REACHED = 7, STOPPED_AFTER_DDL_APPLY = 8, STOPPED_LOW_MEMORY = 9, STOPPED_LOW_DISK_SPACE = 10 } |
The reason the task stopped. |
LogStreamStaging |
string |
If the task is writing to/reading from the Log Stream staging folder, the name of the associated Log Stream Staging task will be returned. Otherwise, an empty string will be returned. |
Message |
string |
The message if the task stopped due to an error. |
AssignedTags |
array |
Returns the custom tags assigned to the task. If no tags are assigned to the task, an empty array will be returned. |
Return values for Compose tasks
Name | Type | Description |
---|---|---|
type |
string |
One of the following:
|
project |
string |
The name of the Compose project. |
profile | string | See Profile Parameters. |
name |
string |
The name of the task or workflow appended with a double underscore and the project name. Example: mytask__myproject |
description |
string |
The task description. If there is no description, an empty string will be returned. |
state |
string |
The current task state. |
message |
string |
The message shown in the event that the task ends with an error. |
options |
AemCommonSettings |
- |
FullLoadEnabled |
bool |
Indicates whether the Full Load option is enabled. Can be "true" or "false". |
ApplyChangesEnabled |
bool |
Indicates whether the Change Processing option is enabled. Can be "true" or "false". |
Name | Type | Description |
---|---|---|
source_endpoint |
TaskEndpoint |
- |
name |
string |
The logical name of the landing database. |
type |
string |
The landing database type. |
Name | Type | Description |
---|---|---|
target_endpoint |
TaskEndpoint |
- |
name |
string |
The logical name of the storage database. |
type |
string |
The storage database type. |
LoadingCompleted |
bool |
Indicates whether the loading process has completed. Can be "true" or "false". |
LoadingStart |
string |
The start time of the loading process. Format: YYY MM DD Timezone: UTC |
LoadingEnd |
string |
The end time of the loading process. Format: YYY MM DD Timezone: UTC |
Name | Type | Description |
---|---|---|
LoadingCounters |
AemTaskFullLoadCounters |
- |
TablesTotalCount |
int |
The total number of tables. |
TablesCompletedCount |
int |
The number of tables that have been loaded into the target endpoint. |
TablesLoadingCount |
int |
The number of tables that are currently being loaded into the target endpoint. |
TablesQueuedCount |
int |
The number of tables that are waiting to be loaded due to an error. |
TablesWithErrorCount |
int |
The number of tables that could not be loaded due to an error. |
CommandsTotalCount |
int |
The total number of commands executed. |
CommandsCompletedCount |
int |
The total number of commands completed. |
AssignedTags |
array |
Returns the custom tags assigned to the task. If no tags are assigned to the task, an empty array will be returned. |
Errors
All of the general errors as well as the errors listed in the table below.
Error | Message | Description |
---|---|---|
AEM_TASK_NOT_FOUND |
Replication task{task} on server {server} could not be found. | The task name is unknown to Qlik Enterprise Manager. |