更新时间:2023-06-15 GMT+08:00

查询作业文件

功能介绍

从OBS路径上导入作业前,可以通过此接口查询导入作业文件中是否有作业和脚本。

URI

  • URI格式

    POST /v1/{project_id}/jobs/check-file

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

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

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

请求消息

表2 参数说明

参数名

是否必选

参数类型

说明

path

String

有OBS场景: 作业定义文件在OBS上的路径。例如obs://myBucket/jobs.zip

响应消息

表3 参数说明

参数名

是否必选

参数类型

说明

jobs

List<Job>

作业信息,参考表4

scripts

List<Script>

脚本信息,表5

表4 job字段数据结构说明

参数名

是否必选

参数类型

说明

params

Map<String,String>

作业参数

name

String

作业名称

path

String

作业路径

表5 Script字段数据结构说明

参数名

是否必选

参数类型

说明

name

String

脚本名称

path

String

脚本路径

表6 Resource字段数据结构说明

参数名

是否必选

参数类型

说明

name

String

资源名称

status

Int

资源状态,0代表资源不存在,1代表资源存在。

type

String

资源类型,包含:

  • DWS_CLUSTER:DWS集群
  • DWS_CONNECTION:DWS连接
  • DLI_QUEUE:DLI队列
  • DLI_CONNECTION:DLI连接
  • CDM_CLUSTER:CDM集群
  • GES_GRAPH:GES图

示例

查询OBS上作业文件中的参数定义。

  • 请求
    POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/check-file
    {
    "path": "obs://aaaaa/DLF_myJob.zip"
    }
  • 成功响应
    {
        "jobs":[
            {
                "name":"test",
                "path":"/test",
                "params":{
                    "ddd":"dddd"
                }
            },
            {
                "name":"test1",
                "path":"/test",
                "params":{
                    "ddd":"dddd"
                }
            }
        ],
        "scripts":[
            {
                "name":"script1",
                "path":"/path1"
            },
            {
                "name":"script2",
                "path":"/path1"
            }
        ]
    }
  • 失败响应

    HTTP状态码 400

    {
        "error_code":"DLF.0815",
        "error_msg":"Fail to read OBS file."
    }

状态码

状态码请参见状态码