Call the ListDataServiceGroups operation to query the list of dataservice studio workflow.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Required ListDataServiceGroups

The operation that you want to perform.

PageNumber Integer Yes 1

The number of the page. Pages start from 1. Default value: 1.

PageSize Integer Yes 10

The size of each page. The minimum value is 1. The maximum value is 50. The default value is 10.

ProjectId Long Yes 10000

The ID of the DataWorks workspace.

RegionId String Required cn-shanghai

The ID of the region where your project resides.

TenantId Long Yes 10001

The ID of the tenant.

GroupNameKeyword String No The test workflow

Workflow name as a keyword.

Response parameters

Parameter Type Example Description
GroupPagingResult Struct

The pagination result of the workflow.

Groups Array of Group

The list of workflow.

ApiGatewayGroupId String 100abc

The ID of the API Gateway group to which the workflow belongs.

CreatedTime String 2020-09-24T18:37:51+0800

The time when the workflow was created.

CreatorId String 10001

The UID of the Creator. Some historical workflow may be empty.

Description String Workflow description

The description of the workflow.

GroupId String ds_123abc

The ID of the workflow.

GroupName String Workflow name

The name of the workflow instance.

ModifiedTime String 2020-09-24T18:37:51+0800

The time when the workflow was edited.

ProjectId Long 10002

The ID of the DataWorks workspace.

TenantId Long 10003

The ID of the tenant.

PageNumber Integer 1

The number of the page, which is consistent with the PageNumber value in the request.

PageSize Integer 10

The size of each page, which is the same as the value of PageSize in the request.

TotalCount Integer 100

The total number of records returned.

RequestId String 0000-ABCD-EF****

The unique ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=ListDataServiceGroups
&PageNumber=1
&PageSize=10
&ProjectId=10000
&RegionId=cn-shanghai
&TenantId=10001
&<Common request parameters>

Sample success responses

XML format

<RequestId>0000-ABCD-EF****</RequestId>
<GroupPagingResult>
    <TotalCount>100</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Groups>
        <GroupName> workflow name </GroupName>
        <TenantId>10003</TenantId>
        <Description> workflow description </Description>
        <CreatedTime>2020-09-24T18:37:51+0800</CreatedTime>
        <ModifiedTime>2020-09-24T18:37:51+0800</ModifiedTime>
        <CreatorId>10001</CreatorId>
        <ApiGatewayGroupId>100abc</ApiGatewayGroupId>
        <ProjectId>10002</ProjectId>
        <GroupId>ds_123abc</GroupId>
    </Groups>
</GroupPagingResult>

JSON format

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

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly because you have not activated DataWorks.
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.

For a list of error codes, visit the API Error Center.