Querying Job Execution History
Function
This API is used to query the job execution history.
Calling Method
For details, see Calling APIs.
URI
GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/submissions
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account 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" } ] }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cdm.v1.region.cdmRegion; import com.huaweicloud.sdk.cdm.v1.*; import com.huaweicloud.sdk.cdm.v1.model.*; public class ShowSubmissionsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); cdmClient client = cdmClient.newBuilder() .withCredential(auth) .withRegion(cdmRegion.valueOf("<YOUR REGION>")) .build(); ShowSubmissionsRequest request = new ShowSubmissionsRequest(); request.withClusterId("{cluster_id}"); try { ShowSubmissionsResponse response = client.showSubmissions(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcdm.v1.region.cdm_region import cdmRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcdm.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) \ client = cdmClient.new_builder() \ .with_credentials(credentials) \ .with_region(cdmRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowSubmissionsRequest() request.cluster_id = "{cluster_id}" response = client.show_submissions(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cdm "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdm/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdm/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cdm/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := cdm.NewcdmClient( cdm.cdmClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowSubmissionsRequest{} request.ClusterId = "{cluster_id}" response, err := client.ShowSubmissions(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot