全部产品
Search
文档中心

大数据开发治理平台 DataWorks:DeployFile - 部署文件

更新时间:Sep 03, 2026

发布文件至生产环境。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

ProjectId

integer

否

DataWorks 工作空间的 ID。 您可以登录 DataWorks 管控台,进入工作空间配置页面获取工作空间 ID。该参数与 ProjectIdentifier 参数,二者必须设置其一,用来确定本次 API 调用操作的 DataWorks 工作空间。

10000

ProjectIdentifier

string

否

DataWorks 工作空间名称。 您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间名称。该参数与 ProjectId 参数,二者必须设置其一,用来确定本次 API 调用操作的 DataWorks 工作空间。

dw_project

FileId

integer

否

文件的 ID,您可以通过 ListFiles 查询对应文件的 ID。该参数与 NodeId 参数配置一个即可。

10000001

Comment

string

否

发布的说明信息。

First release task

NodeId

integer

否

待发布文件在调度系统对应的任务 ID。 该参数与 FileId 参数配置一个即可。

2000001

返回参数

名称

类型

描述

示例值

object

返回结果。

HttpStatusCode

integer

Http 状态码。

200

Data

integer

发布包的 ID。后续需要将该 ID 作为参数调用 GetDeployment 接口,获取本次发布的具体情况。

30000001

RequestId

string

请求 ID。

0000-ABCD-EFG****

ErrorMessage

string

错误信息

The connection does not exist.

Success

boolean

调用是否成功。 取值如下:

  • true:调用成功。

  • false:调用失败。

true

ErrorCode

string

错误码

Invalid.Tenant.ConnectionNotExists

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Data": 30000001,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}

错误码

HTTP status code

错误码

错误信息

描述

500 InternalError.System An internal system error occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. 没有权限,请授权
429 Throttling.Api The request for this resource has exceeded your available limit.
429 Throttling.System The DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。