# 查询作业状态 - ShowJobStatus #### 功能介绍 查询作业状态接口。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dataartsstudio/making_request.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}/status 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 | | cluster_id | 是 | String | 集群ID，获取方法请参见[获取集群列表](https://support.huaweicloud.com/api-dataartsstudio/ListClusters.html)。 | | job_name | 是 | String | 作业名称。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token，使用[Token认证](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0010.html)时必选。通过调用IAM服务的"获取用户Token"接口获取响应消息头中X-Subject-Token的值。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | submissions | Array of [Submission] objects | 作业运行信息，详见submissions参数说明。 | 表4Submission | 参数 | 参数类型 | 描述 | |:---|:---|:---| | isIncrementing | Boolean | 作业是否为增量迁移。 | | job-name | String | 作业名称。 | | counters | [counters] object | 作业运行结果统计，当"status"为"SUCCEEDED"时才有此字段。 | | isStopingIncrement | String | 是否停止增量迁移。 | | is-execute-auto | Boolean | 是否定时执行作业。 | | last-update-date | Long | 作业最后更新时间，单位：毫秒。 | | last-update-user | String | 最后更新作业状态的用户。 | | isDeleteJob | Boolean | 作业执行完成后是否删除。 | | creation-user | String | 创建用户。 | | creation-date | Long | 创建时间，单位：毫秒。 | | external-id | String | 作业ID。 | | progress | Float | 作业进度，失败时为"-1"，其它情况为0～100。 | | submission-id | Integer | 作业提交ID。 | | delete_rows | Integer | 删除数据行数。 | | update_rows | Integer | 更新数据行数。 | | write_rows | Integer | 写入数据行数。 | | execute-date | Long | 执行时间，单位：毫秒。 | | status | String | 作业状态： - BOOTING：启动中。 - FAILURE_ON_SUBMIT：提交失败。 - RUNNING：运行中。 - SUCCEEDED：成功。 - FAILED：失败。 - UNKNOWN：未知。 - NEVER_EXECUTED：未被执行。 | | error-details | String | 错误详情，当"status"为"FAILED"时才有此字段。 | | error-summary | String | 错误总结，当"status"为"FAILED"时才有此字段。 | 表5counters | 参数 | 参数类型 | 描述 | |:---|:---|:---| | org.apache.sqoop.submission.counter.SqoopCounters | [counter] object | 作业运行结果统计。 | 表6counter | 参数 | 参数类型 | 描述 | |:---|:---|:---| | BYTES_WRITTEN | Long | 写入的字节数。 | | TOTAL_FILES | Integer | 总文件数。 | | ROWS_READ | Long | 读取的行数。 | | BYTES_READ | Long | 读取的字节数。 | | ROWS_WRITTEN | Long | 写入的行数。 | | FILES_WRITTEN | Integer | 写入的文件数。 | | FILES_READ | Integer | 读取的文件数。 | | TOTAL_SIZE | Long | 总字节数。 | | FILES_SKIPPED | Integer | 跳过的文件数。 | | ROWS_WRITTEN_SKIPPED | Long | 跳过的行数。 | #### 请求示例 ``` GET /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/6ec9a0a4-76be-4262-8697-e7af1fac7920/cdm/job/jdbc2hive/status ``` #### 响应示例 **状态码：200** OK。 ``` { "submissions" : [ { "job-name" : "jdbc2hive", "creation-user" : "cdm", "creation-date" : 1536905778725, "progress" : 1, "status" : "BOOTING" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ShowJobStatusSolution { 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("")) .build(); ShowJobStatusRequest request = new ShowJobStatusRequest(); request.withClusterId("{cluster_id}"); request.withJobName("{job_name}"); try { ShowJobStatusResponse response = client.showJobStatus(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()); } } } ``` - [Python] ``` # coding: utf-8 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CdmClient.new_builder() \ .with_credentials(credentials) \ .with_region(CdmRegion.value_of("")) \ .build() try: request = ShowJobStatusRequest() request.cluster_id = "{cluster_id}" request.job_name = "{job_name}" response = client.show_job_status(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cdm.CdmClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cdm.NewCdmClient(hcClient) request := &model.ShowJobStatusRequest{} request.ClusterId = "{cluster_id}" request.JobName = "{job_name}" response, err := client.ShowJobStatus(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CDM/sdk?api=ShowJobStatus)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dataartsstudio/ErrorCode.html)。