更新时间:2022-12-07 GMT+08:00

上传file类型分组资源

功能介绍

该API用于在project下上传file类型模块。

上传同名file模块时,新模块将会覆盖旧模块。

URI

  • URI格式:

    POST /v2.0/{project_id}/resources/files

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

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

请求消息

表2 请求参数

参数名称

是否必选

参数类型

说明

paths

Array of Strings

用户OBS对象路径列表,OBS对象路径为OBS对象URL。

group

String

所属资源分组名。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

group_name

String

分组名称。

status

String

上传分组资源状态。

resources

Array of strings

该模块包含的资源包名列表。

details

Array of body

分组资源包的详细信息。具体请参考表4

create_time

Long

模块上传的unix时间戳。

update_time

Long

模块更新的unix时间戳。

is_async

Boolean

是否使用异步方式上传资源包。默认值为“false”,表示不使用异步方式。推荐使用异步方式上传资源包。

owner

String

资源包拥有者。

description

String

资源模块描述。

module_name

String

资源模块名

module_type

String

资源模块类型。

  • jar:用户jar文件;
  • pyFile:用户python文件;
  • file:用户文件。
表4 details参数说明

参数名称

是否必选

参数类型

说明

create_time

Long

资源包上传的unix时间。是单位为“毫秒”的时间戳。

update_time

Long

更新已上传资源包的unix时间。是单位为“毫秒”的时间戳。

resource_type

String

资源类型,此处为file。

resource_name

String

资源名。

status

String

  • "UPLOADING"表示正在上传。
  • "READY"表示资源包已上传。
  • "FAILED"表示资源包上传失败。

underlying_name

String

资源包在队列中的名字。

is_async

Boolean

是否异步上传资源包。

请求示例

{
    "paths": [
        "https: //test.obs.xxx.com/test_dli.jar",
        "https://test.obs.xxx.com/dli_tf.py"
    ],
    "group": "gatk"
}

响应示例

{
    "group_name": "gatk",
    "status": "READY",
    "resources": [
        "test_dli.jar",
        "dli_tf.py"
    ],
    "details":[
        {
          "create_time":1608804435312,
          "update_time":1608804435312,
          "resource_type":"file",
          "resource_name":"test_dli.jar",
          "status":"READY",
          "underlying_name":"test_dli.jar"
        },
       {
        "create_time":1608804435312,
        "update_time":1608804435312,
        "resource_type":"file",
        "resource_name":"dli_tf.py",
        "status":"READY",
        "underlying_name":"dli_tf.py"
      }
       ],
    "create_time": 1521532893736,
    "update_time": 1521552364503,
    "is_async":false
}

状态码

状态码如表5所示。

表5 状态码

状态码

描述

201

上传成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码