更新时间:2024-08-27 GMT+08:00
分享

查询作业文件

功能介绍

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

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。

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。

workspace

String

工作空间id。

  • 如果不设置该参数,默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据,需要带上该消息头。

响应参数

表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

脚本路径

请求示例

查询OBS上作业文件中的参数定义。作业定义文件在OBS上的路径为obs://aaaaa/DLF_myJob.zip
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."
    }

状态码

状态码请参见状态码

相关文档