ListDIJobMetrics - DataWorks - Alibaba Cloud Documentation Center

Queries metrics for a synchronization task.

Operation description

This API operation is available for all DataWorks editions.

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DIJobId	string	No	The ID of the synchronization task.	11265
StartTime	long	Yes	The beginning of the time range to query.	1586509407
EndTime	long	Yes	The end of the time range to query.	1712205941
MetricName	array	Yes	The metrics that you want to query.
	string	Yes	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

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID. You can use the ID to query logs and troubleshoot issues.	691CA452-D37A-4ED0-9441
PagingInfo	object	The pagination information.
JobMetrics	array<object>	The metrics returned.
jobMetricList	object	The information about a single metric.
Name	string	The name of the metric.	JobDelay
SeriesList	array<object>	The metric data.
SeriesList	object	The metric data.
Time	long	The point in time at which data is sampled based on the metric.	1716881141
Value	double	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 time	Summary of changes	Operation
2024-10-15	The internal configuration of the API is changed, but the call is not affected	View Change Details