调用DeployFile接口发布文件至生产环境-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

接口说明

本接口为异步调用。提交成功后，系统将返回 DeploymentId。您需要使用该 ID 调用 GetDeployment 接口，以查询部署任务的实际执行状态及最终结果。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:*

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
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 参数配置一个即可。	10000022
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
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.

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

变更历史

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