CreateBusiness-DataWorks(DataWorks)-阿里云帮助中心

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	No	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.	10000
ProjectIdentifier	string	No	The unique identifier of the DataWorks workspace, which is the English identifier displayed in the workspace switcher at the top of the DataStudio page. You must specify either this parameter or ProjectId to determine the DataWorks workspace on which the API operation is performed.	dw_project
BusinessName	string	Yes	The name of the business process. The name must be unique within the same workspace.	My business process
Description	string	No	The description of the business process.	test
Owner	string	No	The Alibaba Cloud account ID of the owner of the business process. You can log on to the DataWorks console and hover over the profile picture in the upper-right corner of the top navigation bar to view the account ID. If this parameter is left empty, the Alibaba Cloud account ID of the caller is used by default.	1000000000001
UseType	string	No	The functional module to which the business process belongs. Valid values: NORMAL: DataStudio. MANUAL_BIZ: Manual business process. Valid values: MANUAL_BIZ : Manual business process. NORMAL : DataStudio.	NORMAL

Response elements

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
RequestId	string	The unique ID of the request. You can use this ID to troubleshoot issues.	0000-ABCD-EFG****
ErrorMessage	string	The error message.	The connection does not exist.
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorCode	string	The error code. Description: If the request was successful, this parameter is not returned. If the request failed, this parameter is returned. For more information, see the error codes in this topic.	Invalid.Tenant.ConnectionNotExists
BusinessId	integer	The ID of the business process.	100001

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	No permission, please authorize
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.