Querying Job Status¶

Function¶

This API is used to query the job status.

URI¶

GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/status

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
cluster_id	Yes	String	Cluster ID
job_name	Yes	String	Job name

Request Parameters¶

**Table 2** Request header 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

**Table 3** Response body parameters¶
Parameter	Type	Description
submissions	Array of Submission objects	Job running information. For details, see the descriptions of submission parameters.

**Table 4** Submission¶
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 BOOTING: The job is starting. FAILURE_ON_SUBMIT: The job failed to be submitted. RUNNING: The job is running. SUCCEEDED: The job was successfully executed. FAILED: The job execution failed. UNKNOWN: The job status is unknown. NEVER_EXECUTED: The job was not executed.
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.

**Table 5** counters¶
Parameter	Type	Description
org.apache.sqoop.submission.counter.SqoopCounters	counter object	Job running result statistics. For details, see the descriptions of counter parameters.

**Table 6** counter¶
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/job/jdbc2hive/status

Example Responses¶

Status code: 200

{
  "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.

last updated: 2024-11-13 13:47 UTC - commit: db9c60a6c98025320fa32706a5e58cd02cf7d7f1