提交文件至调度系统的开发环境,生成对应的任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用全部资源表示。
 
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| dataworks:* | update | *全部资源 * | 
 | 无 | 
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| ProjectId | long | 否 | DataWorks 工作空间的 ID。您可以登录 DataWorks 管控台,进入工作空间配置页面获取工作空间 ID。该参数与 ProjectIdentifier 参数,二者必须设置其一,用来确定本次 API 调用操作的 DataWorks 工作空间。 | 100001 | 
| ProjectIdentifier | string | 否 | DataWorks 工作空间名称。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间名称。该参数与 ProjectId 参数,二者必须设置其一,用来确定本次 API 调用操作的 DataWorks 工作空间。 | dw_project | 
| FileId | long | 是 | 文件的 ID,您可以通过 ListFiles 查询对应文件的 ID。 | 1000000 | 
| Comment | string | 否 | 本次提交的说明信息。 | Submit a task for the first time | 
| SkipAllDeployFileExtensions | boolean | 否 | 文件提交成功后是否跳过发布前检查: 
 | false | 
返回参数
示例
正常返回示例
JSON格式
{
  "HttpStatusCode": 200,
  "Data": 3000001,
  "RequestId": "0000-ABCD-EFG****",
  "ErrorMessage": "The connection does not exist.",
  "Success": true,
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 | 
|---|---|---|---|
| 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. | DataWorks系统繁忙,请稍后再试。 | 
| 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. | 系统内部错误,请稍后再试。 | 
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | 
|---|---|---|
| 2022-07-20 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 | 
