文档

ListDataServiceGroups - 查询数据服务业务流程列表

更新时间:

调用ListDataServiceGroups查询数据服务业务流程列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*Read
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PageNumberinteger

页码,从 1 开始,默认值为 1。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10
ProjectIdlong

工作空间的 ID。

10000
TenantIdlong

该字段已废弃。租户 ID。

10001
GroupNameKeywordstring

业务流程名称关键词,可以进行子串匹配。

测试业务流程

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID,一次请求的唯一标识。

0000-ABCD-EF****
GroupPagingResultobject

业务流程的分页结果。

PageNumberinteger

页码,和请求中的 PageNumber 一致。

1
PageSizeinteger

每页显示的条数,默认为 10 条,最大 100 条。

10
TotalCountinteger

总记录数。

100
Groupsobject []

业务流程列表。

ModifiedTimestring

业务流程的编辑时间。

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

业务流程的描述。

业务流程描述
GroupNamestring

业务流程名称。

业务流程名称
GroupIdstring

业务流程的 ID。

ds_123abc
ProjectIdlong

工作空间的 ID。

10002
ApiGatewayGroupIdstring

业务流程绑定的 API 网关分组 ID。

100abc
CreatorIdstring

创建人 UID,部分历史业务流程的创建人 UID 可能为空。

10001
CreatedTimestring

业务流程的创建时间。

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

租户 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错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限,请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙,请稍后再试。
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.系统内部错误,请稍后再试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:429
    删除错误码:500
  • 本页导读 (1)