Queries workflows.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListBusiness |
The operation that you want to perform. |
PageNumber | Integer | Yes | 1 |
The number of data pages that are requested. |
PageSize | Integer | Yes | 10 |
The number of entries to return on each page. Default value: 10. Maximum value: 100. |
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. |
Keyword | String | No | my |
The keyword used for fuzzy matching of workflow. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Data | Struct |
The details of the workflow list. |
|
Business | Array of Business |
The details of the workflow. |
|
BusinessId | Long | 3000001 |
The ID of the workflow. |
BusinessName | String | My first workflow |
The name of the workflow. |
Description | String | My first workflow |
The description of the workflow. |
Owner | String | 34824327**** |
The person responsible for workflow. |
ProjectId | Long | 10000 |
The ID of the workspace to which the workflow belongs. |
UseType | String | NORMAL |
The functional module of the workflow, including NORMAL (data analytics) and MANUAL_BIZ (manually triggered workflow workflow). |
PageNumber | Integer | 1 |
The number of the page to return. |
PageSize | Integer | 10 |
The size of the current data page. |
TotalCount | Integer | 13 |
The total number of data records that meet the query conditions. |
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. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=ListBusiness &PageNumber=1 &PageSize=10 &ProjectId=10000 &RegionId=cn-zhangjiakou &<common request parameters>
Sample success responses
XML
format
<RequestId> 0000-abcd-efg**** </RequestId> <HttpStatusCode> 200 </HttpStatusCode> <Data> <TotalCount> 13 </TotalCount> <PageSize> 10 </PageSize> <PageNumber> 1 </PageNumber> <Business> <Owner> 34824327**** </Owner> <Description> my first workflow </Description> <BusinessName> my first workflow </BusinessName> <UseType> NORMAL </UseType> <ProjectId> 10000 </ProjectId> <BusinessId> 3000001 </BusinessId> </Business> </Data> <Success> true </Success>
JSON
Format
{"RequestId": "0000-abcd-EFG %}*", "HttpStatusCode": 200, "Data": { "TotalCount": 13, "PageSize": 10, "PageNumber": 1, "Business": { "Owner": "34824327 TotalCount *", "Description": "My first workflow", "BusinessName": "My first workflow ", "UseType": "NORMAL"," ProjectId": 10000, "BusinessId": 3000001 } }, "Success": true}
Error codes
HttpCode | Error codes | Error message | Description |
---|---|---|---|
403 | Forbidden.Access | Access is forbidden. Activate DataWorks first. | You have restricted access. Please activate DataWorks Enterprise Edition or above. |
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. |
403 | ResourceNotAuthorized.Api | You are not authorized to access the resources. | You cannot access resources without authorization. |
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. |
Go to the Error Center For more information, see error codes.