文档

CreateBusiness - 创建业务流程

更新时间:

调用CreateBusiness,创建数据开发(DataStudio)的业务流程。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ProjectIdlong

DataWorks 工作空间的 ID,您可以登录 DataWorks 控制台,进入工作空间管理页面查看 ID。

10000
ProjectIdentifierstring

DataWorks 工作空间的唯一标识符(即工作空间名称)。您可以登录 DataWorks 控制台,进入工作空间配置页面查看名称。 该参数与 projectId 参数二者必须设置其一,以确定本次 API 调用操作的 DataWorks 项目。

dw_project
BusinessNamestring

业务流程名称,同一个项目空间下的业务流程名称必须唯一。

我的业务流程
Descriptionstring

业务流程的描述信息。

这是一个通过接口创建的业务流程
Ownerstring

业务流程对应责任人的阿里云账号 ID。您可以登录 DataWorks 控制台,鼠标悬停至顶部菜单栏右侧的用户头像,查看账号 ID。如果该参数为空,则默认使用调用者的阿里云账号 ID。

1000000000001
UseTypestring

业务流程所属的功能模块。取值如下:

  • NORMAL(数据开发)
  • MANUAL_BIZ(手动业务流程)
NORMAL

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
RequestIdstring

本次调用的唯一 ID。出现错误后,您可以根据该 ID 排查问题。

0000-ABCD-EFG****
ErrorMessagestring

错误信息。

The connection does not exist.
Successboolean

调用是否成功。

true
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
BusinessIdlong

业务流程 ID。

100001

示例

正常返回示例

JSON格式

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

JSON格式

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

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.-
429Throttling.SystemThe DataWorks system is busy. Try again later.-
429Throttling.UserYour request is too frequent. Try again later.-
500InternalError.SystemAn internal system error occurred. Try again later.-
500InternalError.UserId.MissingAn internal system error occurred. Try again later.-

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)