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

Queries workflows in a DataWorks workspace.

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 log on to the DataWorks console and go to the Workspace page to obtain the ID. Either this parameter or ProjectIdentifier is required.	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 obtain the name. Either this parameter or ProjectId is required.	dw_project
PageNumber	integer	Yes	The page number for paginated queries.	1
PageSize	integer	Yes	The number of records per page. Default: 10. Maximum: 100.	10
Keyword	string	No	The keyword for fuzzy matching of workflow names.	my

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, used for troubleshooting.	0000-ABCD-EFG****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request was successful.	true
Data	object	The workflow data.
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 match the query conditions.	13
Business	array<object>	The workflows.
	object	The workflow details.
Owner	string	The owner of the workflow.	34824327****
Description	string	The description of the workflow.	test
ProjectId	integer	The ID of the workspace to which the workflow belongs.	10000
BusinessId	integer	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

Success response

JSON format

{
  "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
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.