Queries metrics for a synchronization task.
Operation description
This API operation is available for all DataWorks editions.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| DIJobId |
integer |
No |
The ID of the synchronization task. |
11265 |
| StartTime |
integer |
Yes |
The beginning of the time range to query. |
1586509407 |
| EndTime |
integer |
Yes |
The end of the time range to query. |
1712205941 |
| MetricName |
array |
Yes |
The metrics that you want to query. |
|
|
string |
No |
The metric name. Valid values:
|
delayTime |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. Used to query logs and troubleshoot issues. |
691CA452-D37A-4ED0-9441 |
| PagingInfo |
object |
The pagination information. |
|
| JobMetrics |
array<object> |
The metrics returned. |
|
|
array<object> |
Details of a single metric. |
||
| Name |
string |
The name of the metric. |
JobDelay |
| SeriesList |
array<object> |
The metric data. |
|
|
object |
The metric data. |
||
| Time |
integer |
The timestamp of the metric data sample. |
1716881141 |
| Value |
number |
The sample value. |
10 |
Examples
Success response
JSON format
{
"RequestId": "691CA452-D37A-4ED0-9441",
"PagingInfo": {
"JobMetrics": [
{
"Name": "JobDelay",
"SeriesList": [
{
"Time": 1716881141,
"Value": 10
}
]
}
]
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.