文档首页 > > SDK参考> 使用SDK(JAVA)> 作业管理> 查询作业列表

查询作业列表

分享
更新时间:2020/02/21 GMT+08:00

样例代码

用户可以使用该接口查询作业列表。作业列表查询支持以下参数: name,status,show_detail,cursor,next,limit,order。本示例排序方式选择降序desc,将会列出作业id小于cursor的作业列表信息。示例代码如下:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// Import classes:
import com.huaweicloud.cs.java.v1.client.ApiException;
import com.huaweicloud.cs.java.v1.JobApi;


JobApi apiInstance = new JobApi(apiClient);//apiClient为初始化CS API客户端时创建
String xProjectId = "xProjectId_example"; // String | project id, 用于不同project取token.
String name = "name_example"; // String | 作业名
String status = "status_example"; // String | 作业状态码, 请参考CS文档
Integer clusterId = 56; // Integer | 用户独享集群ID
Boolean showDetail = false; // Boolean | 是否返回作业详情信息
Long cursor = 789L; // Long | 作业ID
Boolean next = true; // Boolean | 是否向下翻页
Integer limit = 20; // Integer | 返回的数据条数
String order = "desc"; // String | 查询结果排序, 升序和降序两种可选
Long rootJobId = 789L; // Long | 边缘父作业ID, 用于查询指定边缘作业的子作业; 不带该参数时, 查询所有非边缘作业和边缘父作业, 不包括边缘子作业
try {
    QueryJobListResponse result = apiInstance.getJobs(xProjectId, name, status, clusterId, showDetail, cursor, next, limit, order, rootJobId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling JobApi#getJobs");
    System.err.println(e.getResponseBody());
    e.printStackTrace();
}

参数说明

表1 参数说明表

参数名

是否必选

参数类型

说明

xProjectId

String

project id,用于不同project取token。

name

String

作业名。

status

String

作业状态码。包括以下状态:

  • jobInit
  • jobSubmitting
  • jobSubmitFail
  • jobRunning
  • jobRunningException
  • jobCanceling
  • jobCancelSuccess
  • jobCancelFail

clusterId

Integer

用户独享集群ID。

showDetail

Boolean

是否返回作业详情信息。默认值为“false”。

cursor

String

作业ID。

next

Boolean

是否向下翻页。默认值为“true”。

limit

Integer

返回的数据条数。默认值为“20”。

order

String

查询结果排序,升序asc和降序desc两种可选,默认值为“desc”。

rootJobId

Integer

边缘父作业ID, 用于查询指定边缘作业的子作业。 不带该参数时, 查询所有非边缘作业和边缘父作业, 不包括边缘子作业。

表2 QueryJobListResponse内的参数说明

参数名

是否必选

参数类型

说明

messageId

String

消息类型ID。

message

String

消息内容。

currentTime

Long

当前时间,毫秒数。

payload

QueryJobListResponsePayload

参数类型说明请参见表3

表3 QueryJobListResponsePayload内的参数说明

参数名

是否必选

参数类型

说明

total

Integer

作业查询结果条数。

jobs

Array

参数类型说明请参见表4

表4 JobEntity内的参数说明

参数名

是否必选

参数类型

说明

jobId

Long

作业ID。

name

String

作业名称。

desc

String

作业描述。

username

String

用户名,show_detail为false时独有。

jobType

String

作业类型。

status

String

作业状态。

statusDesc

String

作业状态描述。

createTime

Long

作业创建时间。

startTime

Long

作业启动时间,0表示尚未启动。

duration

Long

作业运行时长, 单位ms,“show_detail”为“false”时独有。

userId

String

作业所属用户标识,“show_detail”为“true”时独有。

clusterId

Integer

独享的集群资源ID, 当前用户有该独享资源的使用权限, “show_detail”为“true”时独有。

projectId

String

作业所属项目标识,“show_detail”为“true”时独有。

sqlBody

String

Stream SQL语句,“show_detail”为“true”时独有。

runMode

RunModeEnum

作业运行模式,“show_detail”为“true”时独有。

  • shared_cluster:共享模式
  • exclusive_cluster:独享模式
  • edge_node:边缘节点

jobConfig

JobConfig

参数介绍请参见表5

jarUrl

String

jar包的OBS路径,“show_detail”为“true”时独有。

mainClass

String

checkpoint_enabled==true时,用户授权保存快照的OBS路径,“show_detail”为“true”时独有。

args

String

jar包作业运行参数,“show_detail”为“true”时独有。

executionGraph

String

作业执行计划,“show_detail”为“true”时独有。

updateTime

Long

作业更新时间,“show_detail”为“true”时独有。

表5 JobConfig内的参数说明

参数名

是否必选

参数类型

说明

checkpointEnabled

Boolean

是否开启作业自动快照功能,默认为false。

  • true:开启
  • false:关闭

checkpointMode

String

快照模式有两种可选:exactly_once和at_least_once。

checkpointInterval

Integer

快照时间间隔,单位为秒。

logEnabled

Boolean

是否启用日志存储。

obsBucket

String

OBS桶名。

smnTopic

String

SMN主题名。

rootId

Integer

父作业ID。

edgeGroupIds

String

边缘计算组ID列表,多个ID以逗号分隔。

managerSpu

Integer

管理单元SPU个数。

spuNumber

Integer

用户为作业选择的SPU数量,“show_detail”为“true”时独有。

parallelNumber

Integer

用户设置的作业并行数,“show_detail”为“true”时独有。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问