ListBusiness - DataWorks - Alibaba Cloud Documentation Center

Queries a list of workflows.

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 DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.	10000
ProjectIdentifier	string	No	The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.	dw_project
PageNumber	integer	Yes	The requested page number, used for pagination.	1
PageSize	integer	Yes	The number of records per page. Default: 10. Maximum: 100.	10
Keyword	string	No	The keyword, used for fuzzy match of workflow names.	my

Response parameters

Parameter	Type	Description	Example
	object	Responses.
HttpStatusCode	integer	The HTTP status code.	200
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The request ID. Used for troubleshooting when an error occurs.	0000-ABCD-EFG****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request was successful.	true
Data	object	Details of workflows.
PageNumber	integer	The current page number.	1
PageSize	integer	The number of records on the current page.	10
TotalCount	integer	The total number of records that meet the query conditions.	13
Business	array<object>	Information about the workflow list.
Business	object	Information about the workflow list.
Owner	string	The owner of the workflow.	34824327****
Description	string	The description of the workflow.	test
ProjectId	long	The ID of the workspace to which the workflow belongs.	10000
BusinessId	long	The workflow ID.	3000001
BusinessName	string	The name of the workflow.	test
UseType	string	The module to which the workflow belongs. Valid values: NORMAL (Data Studio) and MANUAL_BIZ (Manually Triggered Workflow).	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": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 13,
    "Business": [
      {
        "Owner": "34824327****",
        "Description": "test",
        "ProjectId": 10000,
        "BusinessId": 3000001,
        "BusinessName": "test",
        "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.