文档首页 > > API参考> API> 作业管理> 查询作业

查询作业

分享
更新时间: 2020/05/27 GMT+08:00

功能介绍

该API用于查询用户所有或指定的作业。

URI

  • URI格式
    GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{job_name}?filter={filter}&page_no={page_no}&page_size={page_size}&jobType={jobType}
  • 参数说明

    参数

    是否必选

    类型

    说明

    project_id

    String

    项目ID,获取方法请参见获取项目ID/账号名/AK/SK

    cluster_id

    String

    集群ID。

    job_name

    String

    作业名称,当为“all”时返回所有作业。

    filter

    String

    “job_name”“all”时,此参数用于模糊过滤作业。

    page_no

    Integer

    返回指定页号作业。

    page_size

    Integer

    每页作业数。

    jobType

    String

    要查询的作业类型:
    • jobType=NORMAL_JOB:表示查询表/文件迁移的作业。
    • jobType=BATCH_JOB:表示查询整库迁移的作业。

    不指定该参数时,默认只查询表/文件迁移的作业。

请求

请求样例
GET /v1.1/1551c7f6c808414d8e9f3c514a170f2e/clusters/6ec9a0a4-76be-4262-8697-e7af1fac7920/cdm/job/all?jobType=NORMAL_JOB

响应

  • 响应样例
    {
      "total": 1,
      "jobs": [{
        "name": "oracle2hive",
        "type": "NORMAL_JOB",
        "creation-user": "cdm",
        "creation-date": 1514880878504,
        "update-date": 1514880878083,
        "update-user": "cdm",
        "status": "NEW",
        "from-link-name": "oraclelink",
        "from-connector-name": "generic-jdbc-connector",
        "to-link-name": "hivelink",
        "to-connector-name": "hive-connector",
        "from-config-values": {
            "configs": [
              {
                "inputs": [
                  {
                    "name": "fromJobConfig.useSql",
                    "value": "false"
                  },
                  {
                    "name": "fromJobConfig.schemaName",
                    "value": "rf_database"
                  },
                  {
                    "name": "fromJobConfig.tableName",
                    "value": "rf_from"
                  },
                  {
                    "name": "fromJobConfig.columnList",
                    "value": "AA&BB"
                  },
                  {
                    "name": "fromJobConfig.incrMigration",
                    "value": "false"
                  },
                  {
                    "name": "fromJobConfig.createOutTable",
                    "value": "false"
                  }
                ],
                "name": "fromJobConfig"
              }
            ]
          },
        "to-config-values": {
            "configs": [
              {
                "inputs": [
                  {
                    "name": "toJobConfig.hive",
                    "value": "hive"
                  },
                  {
                    "name": "toJobConfig.database",
                    "value": "rf_database"
                  },
                  {
                    "name": "toJobConfig.table",
                    "value": "rf_to"
                  },
                  {
                    "name": "toJobConfig.tablePreparation",
                    "value": "DO_NOTHING"
                  },
                  {
                    "name": "toJobConfig.columnList",
                    "value": "aa&bb&cc&dd"
                  },
                  {
                    "name": "toJobConfig.shouldClearTable",
                    "value": "true"
                  }
                ],
                "name": "toJobConfig"
              }
            ]
          },
        "driver-config-values": {
            "configs": [
              {
                "inputs": [
                  {
                    "name": "throttlingConfig.numExtractors",
                    "value": "1"
                  },
                  {
                    "name": "throttlingConfig.numLoaders",
                    "value": "1"
                  },
                  {
                    "name": "throttlingConfig.recordDirtyData",
                    "value": "false"
                  }
                ],
                "name": "throttlingConfig"
              },
              {
                "inputs": [],
                "name": "jarConfig"
              },
              {
                "inputs": [
                  {
                    "name": "schedulerConfig.isSchedulerJob",
                    "value": "false"
                  },
                  {
                    "name": "schedulerConfig.disposableType",
                    "value": "NONE"
                  }
                ],
                "name": "schedulerConfig"
              },
              {
                "inputs": [],
                "name": "transformConfig"
              },
              {
                "inputs": [
                  {
                    "name": "retryJobConfig.retryJobType",
                    "value": "NONE"
                  }
                ],
                "name": "retryJobConfig"
              }
            ]
          }
        }
      }],
      "page_no": 1,
      "page_size": 20
    }
  • 响应参数说明

    参数

    是否必选

    类型

    说明

    total

    Integer

    作业数。

    jobs

    列表数据结构

    作业列表,请参见jobs参数说明

    page_no

    Integer

    返回指定页号的作业。

    page_size

    Integer

    每页作业数。

    simple

    Boolean

    当为“true”时返回精简消息,即作业参数只返回参数名和值,不返回参数的“size”“type”“id”等属性。

  • jobs参数说明

    参数

    是否必选

    类型

    说明

    name

    String

    作业的名称。

    type

    String

    作业类型:

    • NORMAL_JOB:表/文件迁移。
    • BATCH_JOB:整库迁移。

    creation-user

    String

    创建的用户。

    creation-date

    Timestamp

    作业创建的时间。

    update-date

    Timestamp

    作业最后更新的时间。

    update-user

    String

    作业最后更新的用户。

    status

    String

    作业最后的执行状态:

    • BOOTING:启动中。
    • RUNNING:运行中。
    • SUCCEEDED:成功。
    • FAILED:失败。
    • NEW:未被执行。

    from-link-name

    String

    源连接名称。

    from-connector-name

    String

    源连接的连接器名称。

    to-link-name

    String

    目的连接的名称。

    to-connector-name

    String

    目的连接的连接器名称。

    from-config-values

    字典数据结构

    源连接的作业参数配置,请参见from-config-values数据结构说明

    to-config-values

    字典数据结构

    目的连接的作业参数配置,请参见to-config-values数据结构说明

    driver-config-values

    字典数据结构

    作业任务参数配置,请参见driver-config-values数据结构说明

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    请求错误,具体返回错误码请参考错误码

    401 Unauthorized

    鉴权失败。

    403 Forbidden

    没有操作权限。

    404 Not Found

    找不到资源。

    500 Internal Server Error

    服务内部错误。

    503 Service Unavailable

    服务不可用。

分享:

    相关文档

    相关产品

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

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

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

字符长度不能超过200

提交反馈 取消

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

智能客服提问云社区提问