All Products
Search
Document Center

DataWorks:ListDIJobMetrics

Last Updated:Dec 05, 2024

Queries metrics for a synchronization task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DIJobIdstringNo

The ID of the synchronization task.

11265
StartTimelongYes

The beginning of the time range to query.

1586509407
EndTimelongYes

The end of the time range to query.

1712205941
MetricNamearrayYes

The metrics that you want to query.

stringYes

The name of the metric. The following six metrics are supported:

  • resourceUtilization: specifies the resource usage of a resource group. This metric is supported only for serverless resource groups.
  • delayTime: specifies the latency on the synchronization task.
  • totalRecordsRead: specifies the number of data records that are read from the source.
  • speedRecordsRead: specifies the rate at which the synchronization task reads data from the source.
  • totalRecordsWrite: specifies the number of data records that are written to the destination.
  • speedRecordsWrite: specifies the rate at which the synchronization task writes data to the destination.
delayTime

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID. You can use the ID to query logs and troubleshoot issues.

691CA452-D37A-4ED0-9441
PagingInfoobject

The pagination information.

JobMetricsarray<object>

The metrics returned.

jobMetricListobject

The information about a single metric.

Namestring

The name of the metric.

JobDelay
SeriesListarray<object>

The metric data.

SeriesListobject

The metric data.

Timelong

The point in time at which data is sampled based on the metric.

1716881141
Valuedouble

The sample value.

10

Examples

Sample success responses

JSONformat

{
  "RequestId": "691CA452-D37A-4ED0-9441",
  "PagingInfo": {
    "JobMetrics": [
      {
        "Name": "JobDelay",
        "SeriesList": [
          {
            "Time": 1716881141,
            "Value": 10
          }
        ]
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-10-15The internal configuration of the API is changed, but the call is not affectedView Change Details