DeployFile_大数据开发治理平台 DataWorks_API文档

2020-05-18

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

dataworks:*	Update	全部资源 *	无	无

请求参数

字段名称	字段详情
ProjectIdinteger<int64>	DataWorks 工作空间的 ID。您可以登录 DataWorks 管控台，进入工作空间配置页面获取工作空间 ID。该参数与 ProjectIdentifier 参数，二者必须设置其一，用来确定本次 API 调用操作的 DataWorks 工作空间。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:10000参考取值来源: ListProjectIds CreateProject AddProjectMemberToRole
ProjectIdentifierstring	DataWorks 工作空间名称。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间名称。该参数与 ProjectId 参数，二者必须设置其一，用来确定本次 API 调用操作的 DataWorks 工作空间。示例值:dw_project参考取值来源: CreateProject GetProject ListProjects
FileIdinteger<int64>	文件的 ID，您可以通过 ListFiles 查询对应文件的 ID。展开详情注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:10000022参考取值来源: GetFile ListFiles SubmitFile
Commentstring	本次发布的说明信息。示例值:First release task
NodeIdinteger<int64>	待发布文件在调度系统对应的任务 ID。该参数与 FileId 参数配置一个即可。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:2000001参考取值来源: ListNodes

返回参数

字段名称	字段详情
HttpStatusCodeinteger<int32>	HTTP 状态码。示例值:200
Datainteger<int64>	发布包的 ID，后续需要将该 ID 作为参数调用 GetDeployment 接口，获取本次发布的具体情况。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:30000001
RequestIdstring	请求 ID。用于出现错误后排查问题。示例值:0000-ABCD-EFG****
ErrorMessagestring	错误信息。示例值:The connection does not exist.
Successboolean	调用是否成功。示例值:true
ErrorCodestring	错误码。示例值:Invalid.Tenant.ConnectionNotExists

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

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.	诊断
500	InternalError.System	An internal system error occurred. Try again later.	诊断
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	诊断

变更历史

暂无变更历史

相关示例

调用DeployFile部署文件，发布文件至生产环境。

2021-09-14