GetDataServiceGroup API to query a business process - DataWorks - Alibaba Cloud - DataWorks

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
TenantId	integer	No	The tenant ID. This parameter is deprecated.	10002
ProjectId	integer	Yes	The workspace ID.	10001
GroupId	string	Yes	The business process ID.	ds_123abc

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0000-ABCD-EF****
Group	object	The details of the business process.
ModifiedTime	string	The time when the business process was last 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	integer	The workspace ID.	10002
ApiGatewayGroupId	string	The ID of the API group that is associated with the business process in the API Gateway console.	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	integer	The tenant ID.	10003

Examples

Success response

JSON format

{
  "RequestId": "0000-ABCD-EF****",
  "Group": {
    "ModifiedTime": "2020-09-24T18:37:51+0800",
    "Description": "Business process description",
    "GroupName": "Business process name",
    "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
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.