Querying Job Monitoring Information
Function
This API is used to query job monitoring information. You can query monitoring information about multiple jobs at the same time.
Debugging
You can debug this API in API Explorer.
URI
- URI format
- Parameter description
Table 1 URI parameter Parameter
Mandatory
Type
Description
project_id
Yes
String
Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.
Request
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| job_ids | Yes | Array of Long | List of job IDs. |
Response
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| is_success | No | Boolean | Indicates whether the request is successful. |
| message | No | String | Message content. |
| metrics | No | Object | Information about a job list. For details, see Table 4. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| jobs | No | Array of Objects | Monitoring information about all jobs. For details, see Table 5. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| job_id | No | Long | Job ID. |
| metrics | No | Object | All input and output monitoring information about a job. For details, see Table 6. |
Example
- Example request
{ "job_ids": [298765, 298766] } - Example response
{ "is_success": true, "message": "Message content", "metrics": { "jobs": [ { "job_id": 0, "metrics": { "sources": [ { "name": "Source: KafKa_6070_KAFKA_SOURCE", "records": 0, "corrupted_records": 0 } ], "sinks": [ { "name": "Source: KafKa_6070_KAFKA_SOURCE", "records": 0, "corrupted_records": 0 } ], "total_read_rate": 100, "total_write_rate": 100 } } ] } }
Status Codes
| Status Code | Description |
|---|---|
| 200 | The query of job monitoring information succeeds. |
| 400 | The input parameter is invalid. |
Error Codes
If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.
Last Article: Querying the Job Execution Plan
Next Article: Stopping Jobs in Batches
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.