GetBusiness - DataWorks - Alibaba Cloud Documentation Center

Queries the information about a workflow.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	No	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. You must specify either this parameter or ProjectIdentifier to determine the DataWorks workspace to which the operation is applied.	10000
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Settings panel to obtain the name. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.	dw_project
BusinessId	long	Yes	The ID of the workflow. You can call the ListBusiness operation to query the ID.	1000000001

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code returned.	200
ErrorMessage	string	The error message returned.	The connection does not exist.
RequestId	string	The ID of the request. You can use the ID to troubleshoot issues.	0000-ABCD-EFG****
ErrorCode	string	The error code returned.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request is 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.
ProjectId	string	The ID of the workspace to which the workflow belongs.	10000
BusinessId	long	The ID of the workflow.	1000001
BusinessName	string	The name of the workflow.
UseType	string	The module to which the workflow belongs. Valid values: NORMAL and MANUAL_BIZ.	NORMAL

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
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.	-
500	InternalError.System	An internal system error occurred. Try again later.	-
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history