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

Queries the details of a business process by calling GetBusiness.

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 configuration page to obtain the workspace ID. You must specify either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace for this API call.	10000
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace name. You must specify either this parameter or the ProjectId parameter to determine the DataWorks workspace for this API call.	dw_project
BusinessId	integer	Yes	The ID of the business process. You can call the ListBusiness operation to obtain the ID.	1000000111

Response elements

Element	Type	Description	Example
	object	The response parameters.
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 call was successful. Valid values: true: The call was successful. false: The call failed.	true
Data	object	The details of the business process.
Owner	string	The Alibaba Cloud user ID of the business process owner.	20000****
Description	string	The description of the business process.	This is my first business process.
ProjectId	string	The ID of the DataWorks workspace to which the business process belongs.	10000
BusinessId	integer	The ID of the business process.	1000001
BusinessName	string	The name of the business process. The name must be unique within the same workspace.	The first business process
UseType	string	The functional module to which the business process belongs. Valid values: NORMAL (DataStudio) and MANUAL_BIZ (manual business process).	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.