KSC Open API
Kaspersky Security Center API description
Information about running tasks

Information about running tasks is contained in the "klhst-rt-TskInfo" container. This container has sub-containers whose names correspond to the product names *. Each sub-container has variables that are listed in the table below.

NameTypeDescription
klhst-ProductVersionparamStringVersion *
klhst-rt-TskArrayparamArrayArray of containers, each entry contains values listed below
taskCompletionparamIntTask completion percent
taskStateparamInt

Task state, one of:

  • 0 (TASK_CREATED) Task is just created
  • 1 (TASK_RUNNING) Task is running
  • 2 (TASK_SUSPENDED) Task is suspended
  • 3 (TASK_FAILURE) Fatal error
  • 4 (TASK_COMPLETED) Task completed

taskStorageIdparamString""Tasks storage identifier of the task"" (see HostTasks)
taskTypeparamStringTask type

Example

        +--- (PARAMS_T)
            +---klhst-rt-TskInfo (PARAMS_T)
                +---1103 (PARAMS_T)
                |   +---klhst-ProductVersion = (STRING_T)"1.0.0.0"
                |   +---klhst-rt-TskArray (ARRAY_T)
                |       +---0 (PARAMS_T)
                |       |   +---taskCompletion = (INT_T)0
                |       |   +---taskState = (INT_T)0
                |       |   +---taskStorageId = (STRING_T)""
                |       |   +---taskType = (STRING_T)"FastUpdateNet-Task-KLServer"
                |       +---1 (PARAMS_T)
                |       |   +---taskCompletion = (INT_T)0
                |       |   +---taskState = (INT_T)0
                |       |   +---taskStorageId = (STRING_T)""
                |       |   +---taskType = (STRING_T)"UpdateNet-Task-KLServer"
                |       +---2 (PARAMS_T)
                |       |   +---taskCompletion = (INT_T)0
                |       |   +---taskState = (INT_T)0
                |       |   +---taskStorageId = (STRING_T)""
                |       |   +---taskType = (STRING_T)"KLSRV_TSK_DPNS"
                |       +---3 (PARAMS_T)
                |           +---taskCompletion = (INT_T)0
                |           +---taskState = (INT_T)0
                |           +---taskStorageId = (STRING_T)""
                |           +---taskType = (STRING_T)"KLSRV_TSK_SCAN_AD"
                +---ConnProd (PARAMS_T)
                    +---klhst-ProductVersion = (STRING_T)"1.0.0.0"
                    +---klhst-rt-TskArray (ARRAY_T)
                        +---0 (PARAMS_T)
                        |   +---taskCompletion = (INT_T)0
                        |   +---taskState = (INT_T)1
                        |   +---taskStorageId = (STRING_T)"_LOCAL_6c8edc18-dcd4-4795-8ac3-2a4a715a0272"
                        |   +---taskType = (STRING_T)"ConnProd-TaskType1"
                        +---1 (PARAMS_T)
                        |   +---taskCompletion = (INT_T)0
                        |   +---taskState = (INT_T)1
                        |   +---taskStorageId = (STRING_T)"_LOCAL_7afd3ead-430a-49f7-9339-54e7b0b2a35c"
                        |   +---taskType = (STRING_T)"ConnProd-TaskType2"
                        +---2 (PARAMS_T)
                        |   +---taskCompletion = (INT_T)0
                        |   +---taskState = (INT_T)1
                        |   +---taskStorageId = (STRING_T)"_LOCAL_96b04613-b92e-4d5f-a537-7692760c0ca4"
                        |   +---taskType = (STRING_T)"ConnProd-TaskType3"
                        +---3 (PARAMS_T)
                        |   +---taskCompletion = (INT_T)0
                        |   +---taskState = (INT_T)1
                        |   +---taskStorageId = (STRING_T)"_LOCAL_58cd28a5-a5ad-4efb-bc49-cbbcdc62bafd"
                        |   +---taskType = (STRING_T)"ConnProd-TaskType1"
                        +---4 (PARAMS_T)
                            +---taskCompletion = (INT_T)0
                            +---taskState = (INT_T)1
                            +---taskStorageId = (STRING_T)"_LOCAL_65774e92-2fd7-4aee-a8ff-c16bc9c161cc"
                            +---taskType = (STRING_T)"ConnProd-TaskType2"