All Products
Search
Document Center

DataWorks:GetDataServiceGroup

Last Updated:Nov 21, 2024

Queries a business process.

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TenantIdlongNo

The tenant ID. This parameter is deprecated.

10002
ProjectIdlongYes

The workspace ID.

10001
GroupIdstringYes

The business process ID.

ds_123abc

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

0000-ABCD-EF****
Groupobject

The details of the business process.

ModifiedTimestring

The time when the business process was last modified.

2020-09-24T18:37:51+0800
Descriptionstring

The description of the business process.

Test
GroupNamestring

The name of the business process.

Test
GroupIdstring

The business process ID.

ds_123abc
ProjectIdlong

The workspace ID.

10002
ApiGatewayGroupIdstring

The ID of the API group that is associated with the business process in the API Gateway console.

100abc
CreatorIdstring

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
CreatedTimestring

The time when the business process was created.

2020-09-24T18:37:51+0800
TenantIdlong

The tenant ID.

10003

Examples

Sample success responses

JSONformat

{
  "RequestId": "0000-ABCD-EF****",
  "Group": {
    "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 codeError codeError messageDescription
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
429Throttling.ApiThe request for this resource has exceeded your available limit.-
429Throttling.SystemThe DataWorks system is busy. Try again later.-
429Throttling.UserYour request is too frequent. Try again later.-
500InternalError.SystemAn internal system error occurred. Try again later.-
500InternalError.UserId.MissingAn internal system error occurred. Try again later.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-10-10The Error code has changedView Change Details