ListDataServiceGroups - DataWorks - Alibaba Cloud Documentation Center

Queries business processes.

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
PageNumber	integer	Yes	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	Yes	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
ProjectId	long	Yes	The workspace ID.	10000
TenantId	long	No	The tenant ID. This parameter is deprecated.	10001
GroupNameKeyword	string	No	The keyword of a business process name. The keyword is used to search for business processes whose names contain this keyword.	Test business process

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0000-ABCD-EF****
GroupPagingResult	object	The paging result for the business processes.
PageNumber	integer	The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 100. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	100
Groups	array<object>	The business processes.
Group	object
ModifiedTime	string	The time when the business process was modified.	2020-09-24T18:37:51+0800
Description	string	The description of the business process.	Test
GroupName	string	The name of the business process.	Test
GroupId	string	The business process ID.	ds_123abc
ProjectId	long	The workspace ID.	10002
ApiGatewayGroupId	string	The ID of the API Gateway group to which the workflow is bound.	100abc
CreatorId	string	The user identifier (UID) of the creator of the business process. The value of this parameter may be empty for creators of some existing business processes.	10001
CreatedTime	string	The time when the business process was created.	2020-09-24T18:37:51+0800
TenantId	long	The tenant ID.	10003

Examples

Sample success responses

JSONformat

{
  "RequestId": "0000-ABCD-EF****",
  "GroupPagingResult": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Groups": [
      {
        "ModifiedTime": "2020-09-24T18:37:51+0800",
        "Description": "Test\n",
        "GroupName": "Test\n",
        "GroupId": "ds_123abc",
        "ProjectId": 10002,
        "ApiGatewayGroupId": "100abc",
        "CreatorId": "10001",
        "CreatedTime": "2020-09-24T18:37:51+0800",
        "TenantId": 10003
      }
    ]
  }
}

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
2023-10-09	The Error code has changed	View Change Details