数据治理中心 DataArts Studio-查询作业实例列表:URI

时间:2023-11-01 16:20:39

URI

  • URI格式

    GET /v1/{project_id}/jobs/instances/detail?jobName={jobName}&minPlanTime={minPlanTime}&maxPlanTime={maxPlanTime}&limit={limit}&offset={offset}&status={status}&preciseQuery={preciseQuery}

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,获取方法请参见项目ID和帐号ID

    jobName

    String

    作业名称。

    • 如果要查询指定批处理作业的实例列表,jobName就是批处理作业名称;
    • 如果要查询实时作业下某个节点关联的子作业,jobName格式为[实时作业名称]_[节点名称]。

    minPlanTime

    Long

    返回计划执行时间大于minPlanTime的作业实例,单位为毫秒ms。

    maxPlanTime

    Long

    返回计划执行时间小于maxPlanTime的作业实例,单位为毫秒ms。

    limit

    int

    分页返回结果,指定每页最大记录数。

    范围[1,1000]

    默认值:10

    offset

    int

    分页的起始页,默认值为0。取值范围大于等于0。

    status

    String

    实例运行状态:

    • waiting: 等待运行
    • running:运行中
    • success: 运行成功
    • fail: 运行失败
    • running-exception: 运行异常
    • pause: 暂停
    • manual-stop: 取消

    preciseQuery

    boolean

    支持通过作业名进行精确查询。

support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0094.html