CreateBusiness - DataWorks - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	CreateBusiness	The operation that you want to perform.
BusinessName	String	Yes	My workflow	The name of the workflow. The name must be unique in a workspace.
RegionId	String	Yes	cn-shanghai	The ID of the region in which the DataWorks workspace resides. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint that is used to call the operation.
ProjectId	Long	No	10000	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to view the ID.
ProjectIdentifier	String	No	dw_project	The unique identifier of the DataWorks workspace, which is the name of the workspace. You can log on to the DataWorks console and go to the Workspace Management page to view the name. You must set one of the ProjectIdentifier and ProjectId parameters to specify the DataWorks workspace on which you want to perform the operation.
Description	String	No	A workflow created by calling the operation	The description of the workflow.
Owner	String	No	1000000000001	The ID of the Alibaba Cloud account used by the owner of the workflow. You can log on to the DataWorks console and move the pointer over the profile picture in the upper-right corner to view the ID. If this parameter is not set, the ID of the Alibaba Cloud account of the user who calls the operation is used.
UseType	String	No	NORMAL	The type of the workflow. Valid values: NORMAL: Data Analytics workflow MANUAL_BIZ: manually triggered workflow

Response parameters


Parameter	Type	Example	Description
BusinessId	Long	100001	The ID of the workflow.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	The error code.
ErrorMessage	String	The connection does not exist.	The error message.
HttpStatusCode	Integer	200	The HTTP status code.
RequestId	String	0000-ABCD-EFG****	The ID of the request. You can troubleshoot errors based on the ID.
Success	Boolean	true	Indicates whether the request is successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateBusiness
&BusinessName=My workflow
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<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 format

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

Error codes


HTTP status code	Error code	Error message	Description
500	InternalError.System	An internal system error occurred. Try again later.	The error message returned because an internal error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	The error message returned because an internal error occurred. Try again later.
429	Throttling.Api	The request for this resource has exceeded your available limit.	The error message returned because the number of requests for the resource has exceeded the upper limit.
429	Throttling.System	The DataWorks system is busy. Try again later.	The error message returned because the DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.	The error message returned because excessive requests have been submitted within a short period of time. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or DataWorks Ultimate Edition.

For a list of error codes, visit the API Error Center.