文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API（V2）/ 作业开发API/ 发布任务包
更新时间：2024-06-18 GMT+08:00
查看PDF
分享

发布任务包

功能介绍

目前支持发布包管理中相关包的发布，支持发布多个任务包。

调试

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

URI

  • URI格式

    POST /v2/{project_id}/factory/release-packages/deploy

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

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

    项目编号，获取方法请参见项目ID和账号ID。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

否

String

工作空间id。

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

X-Auth-Token

否

String

IAM Token

最小长度：0

最大长度：4096

Content-Type

否

String

有Body体的情况下必选，无Body体的情况下则无需填写和校验。

示例：Content-Type: application/json;charset=UTF-8
表3 请求Body参数

参数名

是否必选

参数类型

说明

package_ids

是

array[string]

发布包ID集合，不能为空，且一次不能超过100个

startup_mode

否

Integer

发布后是否立即启动作业。取值范围为0和1，默认为1

1：发布成功后立即启动作业

0：不立即启动

响应参数

表4 响应参数说明

参数名

是否必选

参数类型

说明

deploy_package_details

否

List<Object>

发布包信息，请参考表5。
表5 deploy_package_details数据结构

参数名

是否必选

参数类型

说明

asy_subtask_num

否

Integer

总的异步执行的子任务个数。

asy_task_id

否

String

异步作业id，返回给前台轮询结果。

package_id

否

Long

发布包ID。

请求示例

POST /v2/b384b9e9ab9b4ee8994c8633aabc9505/factory/release-packages/deploy
{
  "package_ids": ["23"],
  "startup_mode": 0
}

响应示例

  • 成功响应

    HTTP状态码 200

    {
    "deploy_package_details": [
        {
            "asy_subtask_num": 1,
            "asy_task_id": "ff8080818c81c8ab018c8b43f85d0008",
            "package_id": 23
        }
    ]
}
  • 失败响应

    HTTP状态码 400

    {
  "error_code": "DLF.0810",
  "error_msg": "Task does not exist."
}
父主题： 作业开发API

相关文档