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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateBusiness

要执行的操作。

BusinessName String 我的业务流程

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

RegionId String cn-shanghai

地域信息,通常为服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

ProjectId Long 10000

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

ProjectIdentifier String dw_project

DataWorks工作空间的唯一标识符(即工作空间名称)。您可以登录DataWorks控制台,进入工作空间配置页面查看名称。

该参数与projectId参数二者必须设置其一,以确定本次API调用操作的DataWorks项目。

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

业务流程的描述信息。

Owner String 1000000000001

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

UseType String NORMAL

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

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

返回数据

名称 类型 示例值 描述
BusinessId Long 100001

业务流程ID。

ErrorCode String Invalid.Tenant.ConnectionNotExists

错误码。

ErrorMessage String The connection does not exist.

错误信息。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0000-ABCD-EFG****

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

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateBusiness
&BusinessName=我的业务流程
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML格式

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<BusinessId>100001</BusinessId>
<Success>true</Success>

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
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. 您的请求过于频繁,请尝试放缓请求速度。
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. 您被限制访问,请开通DataWorks企业版或旗舰版。

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