GetBusiness-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 DataWorks workspace ID. You can obtain this value from the Workspace Management page in the DataWorks console. Specify either this parameter or ProjectIdentifier.	10000
ProjectIdentifier	string	No	The DataWorks workspace name. You can obtain this value from the Workspace Settings panel in the DataWorks console. Specify either this parameter or ProjectId.	dw_project
BusinessId	integer	Yes	The workflow ID. You can call the ListBusiness operation to query the ID.	1000000111

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The request ID. You can use this ID to troubleshoot issues.	0000-ABCD-EFG****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request was successful.	true
Data	object	The details of the workflow.
Owner	string	The Alibaba Cloud account ID of the workflow owner.	20000****
Description	string	The description of the workflow.	This is my first business process.
ProjectId	string	The workspace ID of the workflow.	10000
BusinessId	integer	The workflow ID.	1000001
BusinessName	string	The workflow name.	The first business process
UseType	string	The module to which the workflow belongs. Valid values: NORMAL and MANUAL_BIZ.	NORMAL

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "Owner": "20000****",
    "Description": "This is my first business process.",
    "ProjectId": "10000",
    "BusinessId": 1000001,
    "BusinessName": "The first business process",
    "UseType": "NORMAL"
  }
}

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.