Querying Job Execution History
Function
This API is used to query the job execution history.
URI
GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/submissions
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
cluster_id |
Yes |
String |
Cluster ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
jname |
Yes |
String |
Job name |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
submissions |
Array of Submission objects |
Job running information. For details, see the descriptions of submission parameters. |
total |
Integer |
Total number of historical records for a job |
page_no |
Integer |
Page number |
page_size |
Integer |
Number of records on each page. The default value is 10. |
Parameter |
Type |
Description |
---|---|---|
isIncrementing |
Boolean |
Whether the job migrates incremental data |
job-name |
String |
Job name |
counters |
counters object |
Job running result statistics. This parameter is available only when status is SUCCEEDED. For details, see the description of the counters parameter. |
isStopingIncrement |
String |
Whether to stop incremental data migration |
is-execute-auto |
Boolean |
Whether to execute the job as scheduled |
last-update-date |
Long |
Time when the job was last updated |
last-udpate-user |
String |
User who last updated the job status |
isDeleteJob |
Boolean |
Whether to delete the job after it is executed |
creation-user |
String |
User who created the job |
creation-date |
Long |
Creation time |
external-id |
String |
Job ID |
progress |
Float |
Job progress. If a job fails, the value is -1. Otherwise, the value ranges from 0 to 100. |
submission-id |
Integer |
Job submission ID |
delete_rows |
Integer |
Number of deleted rows |
update_rows |
Integer |
Number of updated rows |
write_rows |
Integer |
Number of written rows |
execute-date |
Long |
Execution time |
status |
String |
Job status
|
error-details |
String |
Error details. This parameter is available only when status is FAILED. |
error-summary |
String |
Error summary. This parameter is available only when status is FAILED. |
Parameter |
Type |
Description |
---|---|---|
org.apache.sqoop.submission.counter.SqoopCounters |
counter object |
Job running result statistics. For details, see the descriptions of counter parameters. |
Parameter |
Type |
Description |
---|---|---|
BYTES_WRITTEN |
Long |
Number of bytes that are written |
TOTAL_FILES |
Integer |
Total number of files |
ROWS_READ |
Long |
Number of rows that are read |
BYTES_READ |
Long |
Number of bytes that are read |
ROWS_WRITTEN |
Long |
Number of rows that are written |
FILES_WRITTEN |
Integer |
Number of files that are written |
FILES_READ |
Integer |
Number of files that are read |
TOTAL_SIZE |
Long |
Total number of bytes |
FILES_SKIPPED |
Integer |
Number of files that are skipped |
ROWS_WRITTEN_SKIPPED |
Long |
Number of rows that are skipped |
Example Requests
GET /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/6ec9a0a4-76be-4262-8697-e7af1fac7920/cdm/submissions?jname=jdbc2hive
Example Responses
Status code: 200
ok
{ "submissions" : [ { "job-name" : "jdbc2hive", "creation-user" : "cdm", "creation-date" : "1536905778725", "progress" : 1, "status" : "BOOTING" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
ok |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.