All Products
Search
Document Center

:ListDataServiceGroups

最終更新日:May 10, 2024

Queries a list of business processes in DataService Studio.

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

Yes

ListDataServiceGroups

The operation that you want to perform. Set the value to ListDataServiceGroups.

PageNumber

Integer

Yes

1

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

PageSize

Integer

Yes

10

The number of entries per page. Valid values: 1 to 100. Default value: 10.

ProjectId

Long

Yes

10000

The workspace ID.

TenantId

Long

No

10001

The tenant ID. This parameter is deprecated.

GroupNameKeyword

String

No

Test business process

The keyword in the names of business processes. The keyword is used to search for business processes whose names contain the keyword.

Response parameters

Parameter

Type

Example

Description

RequestId

String

0000-ABCD-EF****

The request ID.

GroupPagingResult

Object

The paging result for the business processes.

PageNumber

Integer

1

The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.

PageSize

Integer

10

The number of entries per page. Valid values: 1 to 100. Default value: 10.

TotalCount

Integer

100

The total number of entries returned.

Groups

Array of Group

The business processes.

ModifiedTime

String

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

The time when the business process was last modified.

Description

String

Business process description

The description of the business process.

GroupName

String

Business process name

The name of the business process.

GroupId

String

ds_123abc

The business process ID.

ProjectId

Long

10002

The workspace ID.

ApiGatewayGroupId

String

100abc

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

CreatorId

String

10001

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.

CreatedTime

String

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

The time when the business process was created.

TenantId

Long

10003

The tenant ID.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListDataServiceGroups
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListDataServiceGroupsResponse>
    <GroupPagingResult>
        <Groups/>
    </GroupPagingResult>
</ListDataServiceGroupsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "GroupPagingResult" : {
    "Groups" : [ { } ]
  }
}

Error codes

HTTP status code

Error code

Error message

Description

429

Throttling.Api

The request for this resource has exceeded your available limit.

The number of requests for the resource has exceeded the upper limit.

429

Throttling.System

The DataWorks system is busy. Try again later.

The DataWorks system is busy. Try again later.

429

Throttling.User

Your request is too frequent. Try again later.

Excessive requests have been submitted within a short period of time. Try again later.

500

InternalError.System

An internal system error occurred. Try again later.

An internal error occurred. Try again later.

500

InternalError.UserId.Missing

An internal system error occurred. Try again later.

An internal error occurred. Try again later.

For a list of error codes, see Service error codes.