调用ListDataServiceGroups查询数据服务业务流程列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PageNumber |
integer |
否 |
页码,从 1 开始,默认值为 1。 |
1 |
| PageSize |
integer |
否 |
每页显示的条数,默认为 10 条,最大 50 条。 |
10 |
| ProjectId |
integer |
是 |
工作空间的 ID。 可通过 ListProjects 响应中的 PageResult.ProjectList[].ProjectId 获取。 |
10000 |
| TenantId |
integer |
否 |
该字段已废弃。租户 ID。 |
10001 |
| GroupNameKeyword |
string |
否 |
业务流程名称关键词,可以进行子串匹配。 |
测试业务流程 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID,一次请求的唯一标识。 |
0000-ABCD-EF**** |
| GroupPagingResult |
object |
业务流程的分页结果。 |
|
| PageNumber |
integer |
页码,和请求中的 PageNumber 一致。 |
1 |
| PageSize |
integer |
每页显示的条数,默认为 10 条,最大 100 条。 |
10 |
| TotalCount |
integer |
总记录数。 |
100 |
| Groups |
array<object> |
业务流程列表。 |
|
|
object |
|||
| ModifiedTime |
string |
业务流程的编辑时间。 格式示例为 |
2020-09-24T18:37:51+0800 |
| Description |
string |
业务流程的描述。 |
业务流程描述 |
| GroupName |
string |
业务流程名称。 |
业务流程名称 |
| GroupId |
string |
业务流程的 ID。 |
ds_123abc |
| ProjectId |
integer |
工作空间的 ID。 |
10002 |
| ApiGatewayGroupId |
string |
业务流程绑定的 API 网关分组 ID。 |
100abc |
| CreatorId |
string |
创建人 UID,部分历史业务流程的创建人 UID 可能为空。 |
10001 |
| CreatedTime |
string |
业务流程的创建时间。 格式示例为 |
2020-09-24T18:37:51+0800 |
| TenantId |
integer |
租户 ID。 |
10003 |
示例
正常返回示例
JSON格式
{
"RequestId": "0000-ABCD-EF****",
"GroupPagingResult": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 100,
"Groups": [
{
"ModifiedTime": "2020-09-24T18:37:51+0800",
"Description": "业务流程描述",
"GroupName": "业务流程名称",
"GroupId": "ds_123abc",
"ProjectId": 10002,
"ApiGatewayGroupId": "100abc",
"CreatorId": "10001",
"CreatedTime": "2020-09-24T18:37:51+0800",
"TenantId": 10003
}
]
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. | 没有权限,请授权 |
| 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. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。