Talend Management Console

Download AsyncAPI spec

Talend Management Console is where you schedule, run, and monitor Talend Studio jobs, Data Services, and Routes.

This event API publishes Capacity-Based Pricing (CBP) metrics for managed and unmanaged task executions, so you can track consumption relative to your Qlik Talend Cloud subscription.

Talend Management Console CBP metrics aggregated

Talend Management Console Capacity-Based Pricing (CBP) metrics have been aggregated

Payload

object
  • idstring
    Required

    Unique identifier for the event.

  • timestring

    Timestamp of when the event happened.

    format = "date-time"

  • typestring
    Required

    The type of the event.

    default = "com.qlik.talend-management-console.cbp-execution-metrics.aggregated"

  • sourcestring
    Required

    The source of the event.

    default = "com.qlik/tmc-metrics-collector-job"

  • specversionstring
    Required

    The event is compatible with the CloudEvents specification v1.0.2.

    Can be one of: "1.0"

  • datacontenttypestring

    Content type of the data value. Must adhere to RFC 2046 format.

    minLength = 1

  • tenantidstring
    Required

    Unique identifier for the tenant related to the event.

  • dataobject
    Show data properties
    • tagsarray of strings

      Optional list of tag IDs associated with the task execution

    • jobIdstring
      Required

      Job execution identifier on the engine (e.g. "0349641b-066d-3876-a8ec-d8dfd37b8b3f")

      maxLength = 255

    • eventIdstring

      Unique Identifier for this event, generated by the job

      pattern = "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

    • authorIdstring

      UUID of the author who triggered or created the job (e.g. "e5e1f88c-70e1-475c-8702-d604dea6fea1")

      pattern = "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

    • cbpStatusstring

      Status of the Capacity-Based Pricing execution (for example: EXECUTION_SUCCESS, EXECUTION_FAILED, EXECUTION_TERMINATED).

      maxLength = 64

    • customTagstring

      Custom tag for the execution

      maxLength = 128

    • artifactIdstring

      The identifier of the job artifact (e.g. "6a74320d73e1fa31b2621665").

    • cbpEndTimestring

      The end timestamp of a job

      maxLength = 64

    • cbpJobTypestring

      Job type for the execution, for example "DI" (Data Integration) or "ROUTE".

      maxLength = 64

    • datacenterstring

      Identifier of the datacenter where the execution occurred, if applicable (e.g. "aws_qcs_us")

    • javaVendorstring

      Java vendor/flavour used for the execution (e.g. "Red Hat, Inc.")

      maxLength = 255

    • operatorIdstring

      UUID of the operator who executed or ran the job (e.g. "e5e1f88c-70e1-475c-8702-d604dea6fea1")

      pattern = "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

    • batchNumberinteger
      Required

      Batch number must be at least 1

    • executionIdstring
      Required

      UUID of the TMC execution (e.g. "db51bc77-ab75-4240-9e17-d71bc9f4ab83")

      pattern = "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

    • javaVersionstring

      Java version used for the execution (e.g. "21.0.12")

      maxLength = 255

    • workspaceIdstring

      Workspace id associated with the execution (e.g. "6a6369911945d6abbcbca892").

    • cbpInputSizeinteger

      Deprecated. Input size, replaced with cbpInputBytes

    • cbpIsRootJobboolean

      Flag identifier if the job is root or a child, true for the main job, false for sub-jobs

    • cbpStartTimestring

      The start timestamp of a job

      maxLength = 64

    • cbpDurationMsinteger

      The duration of the execution of a job, unit is milliseconds

    • cbpEventCountinteger

      For DATA_SERVICE, ROUTE, and BIG_DATA_STREAMING jobs, the volume of API calls.

    • cbpInputBytesinteger

      Volume of bytes, for DI jobs.

    • environmentIdstring

      Environment id where the execution ran (e.g. "66c879fb644716127f16d783").

    • studioBuildIdstring

      UUID of the Studio build

      maxLength = 128

    • cbpDurationSecinteger

      Deprecated. The duration of the execution of a job. Replaced with cbpDurationMs.

    • remoteEngineIdstring

      UUID of the Remote Engine running the execution (e.g. "69a6a510-34fd-4167-81fc-faa36f551539")

      pattern = "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

    • runtimeVersionstring

      Runtime version used for the execution (e.g. "8.0.2.R2026-06-RT_R2026-07-v2")

      maxLength = 255

    • cbpScheduleSourcestring

      Schedule type/source (e.g. "managed", "unmanaged")

      maxLength = 64

    • cbpDeltaDurationMsinteger

      The duration of the execution of a job since last received metric for the same execution, unit is milliseconds

    • cbpDeltaEventCountinteger

      for DATA_SERVICE, ROUTE, and BIG_DATA_STREAMING jobs the volume of API calls since last received metric for the same execution

    • cbpDeltaInputBytesinteger

      for DI jobs the volume of bytes since last received metric for the same execution

    • remoteEngineVersionstring

      Remote Engine version used for the execution (e.g. "2.13.11")

      maxLength = 255

    • studioBuildDateTimestring

      Date and time of the Studio build

      maxLength = 255

    • executionMetricOriginstring

      Version of architecture (e.g. "V1","V2") used by the Remote Engine to generate the metrics.

    • remoteEngineClusterIdstring

      UUID of the Remote Engine Cluster running the execution

      pattern = "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

    • marketingStudioVersionstring

      Marketing version of the Studio used for the execution

      maxLength = 255

    • technicalStudioVersionstring

      Technical version of the Studio used for the execution

      maxLength = 255

com.qlik.talend-management-console.cbp-execution-metrics.aggregated

Example payload of the "Talend Management Console CBP metrics aggregated" event

{
  "id": "8b84e4d2-b7a7-42d5-b628-d23089794c71",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.talend-management-console.cbp-execution-metrics.aggregated",
  "source": "com.qlik/tmc-metrics-collector-job",
  "specversion": "1.0",
  "datacontenttype": "string",
  "tenantid": "8fe34c17-6a4f-42ca-a8a1-b49ea11c83d2",
  "data": {
    "tags": [
      "string"
    ],
    "jobId": "string",
    "eventId": "string",
    "authorId": "string",
    "cbpStatus": "string",
    "customTag": "string",
    "artifactId": "string",
    "cbpEndTime": "string",
    "cbpJobType": "string",
    "datacenter": "string",
    "javaVendor": "string",
    "operatorId": "string",
    "batchNumber": 42,
    "executionId": "string",
    "javaVersion": "string",
    "workspaceId": "string",
    "cbpInputSize": 42,
    "cbpIsRootJob": true,
    "cbpStartTime": "string",
    "cbpDurationMs": 42,
    "cbpEventCount": 42,
    "cbpInputBytes": 42,
    "environmentId": "string",
    "studioBuildId": "string",
    "cbpDurationSec": 42,
    "remoteEngineId": "string",
    "runtimeVersion": "string",
    "cbpScheduleSource": "string",
    "cbpDeltaDurationMs": 42,
    "cbpDeltaEventCount": 42,
    "cbpDeltaInputBytes": 42,
    "remoteEngineVersion": "string",
    "studioBuildDateTime": "string",
    "executionMetricOrigin": "string",
    "remoteEngineClusterId": "string",
    "marketingStudioVersion": "string",
    "technicalStudioVersion": "string"
  }
}