Queries the details of a workflow.


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 GetBusiness

The operation that you want to perform.

BusinessId Long Yes 1000000001

The ID of the workflow. ListBusiness Get.

ProjectId Long Yes 10000

Dataworks workspace ID and click the workspace manage icon in the upper-right corner to view the workspace information.

RegionId String Yes cn-zhangjiakou

The list of regions where the services are located.

ProjectIdentifier String No dw_project

Dataworks unique identifier of the workspace, that is, the name of the workspace at the top of the data Development page.

You must specify either this parameter or the ProjectId parameter to determine the Dataworks workspace for the current API call.

Response parameters

Parameter Type Example Description
Data Struct

The details of the workflow.

BusinessId Long 1000001

The ID of the workflow.

BusinessName String First workflow

The name of the workflow.

Description String This is my first workflow

The description of the workflow.

Owner String 20000****

The Alibaba Cloud User ID of the workflow owner.

ProjectId String 10000

The ID workflow workspace to which the DataWorks belongs.

UseType String NORMAL

The functional module of the workflow, including NORMAL (data analytics) and MANUAL_BIZ (manually triggered workflow 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 unique ID of the call. You can use the error ID to troubleshoot the error.

Success Boolean true

Indicates whether the request was successful.


Sample requests

     http(s)://[Endpoint]/? Action=GetBusiness&businesssid=1000000001 &ProjectId=10000 &RegionId=cn-zhangjiakou &<common request parameters> 

Sample success responses

XML format

     <RequestId> 0000-abcd-EFG *** </RequestId> <HttpStatusCode> 200 </HttpStatusCode> <Data> 20000 <Owner> 20000 *** </Owner> <Description> this is my first workflow </Description> <BusinessName> first workflow member </Data> <Success> true </Success> 

JSON Format

     {"RequestId": "0000-abcd-EFG ***", "HttpStatusCode": 200, "Data": { "Owner": "20000 instance Owner *", "Description": "This is my first workflow", "BusinessName": "The first workflow ", "UseType": "NORMAL", "ProjectId": 10000, "BusinessId": 1000001 }, "Success": true} 

Error codes

HttpCode Error codes Error message Description
500 InternalError.System An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. An internal system error occurred. Please try again later.
429 Throttling.Api The request for this resource has exceeded your available limit. The request for the resource exceeds your available upper limit.
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks the system is busy, please try again later.
429 Throttling.User Your request is too frequent. Try again later. Your request is too frequent, please try to slow down the request speed.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. You have restricted access. Please activate DataWorks Enterprise Edition or above.

Go to the Error CenterFor more information, see error codes.