查询数据发布列表

列出当前工作区的数据发布。

GET https://moi.matrixorigin.cn/newmoi/data-share/publishes

调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

• $AI_STUDIO_API_KEY：实际个人访问令牌，通过 X-API-Key Header 传递。

• $WORKSPACE_ID：要查询的工作区 ID，通过 X-Workspace-ID Header 传递。

查询参数

参数	类型	是否必填	说明
keyword	string	否	按关键字搜索。
page	integer	否	页码；不传时返回第 1 页。
page_size	integer	否	每页数量；不传时每页返回 20 条。

请求示例

curl "https://moi.matrixorigin.cn/newmoi/data-share/publishes?page=1&page_size=20" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

成功响应

成功时返回 200。data.list 是当前页，data.total 是匹配总数。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "list": [
      {
        "id": "101",
        "name": "sales-share",
        "source_database_id": "1001",
        "mo_database_name": "sales",
        "table_scope": {
          "mode": "selected",
          "object_ids": ["2001"]
        },
        "obj_display_name": "sales",
        "obj_display_path": "catalog/sales",
        "targets": [
          {
            "workspace_id": "ws-002",
            "workspace_name": "分析工作区"
          }
        ],
        "permission": "read",
        "remark": "共享销售数据",
        "created_by": "user-001",
        "created_at": "2026-08-18T10:00:00Z",
        "updated_at": "2026-08-18T10:00:00Z"
      }
    ],
    "total": 1,
    "page": 1,
    "page_size": 20
  }
}

响应字段如下。

本文中，类型后的 [] 表示数组，例如 string[] 是字符串数组；字段路径中的 [] 表示数组中的每一项，例如 data.list[].id 表示 data.list 数组中每一项的 id 字段。

字段	类型	说明
code	string	成功时为 OK。
msg	string	成功时为 OK。
data.list	object（对象数组）	当前页发布列表；无结果时为空数组。
data.total	integer	匹配总数。
data.page	integer	当前页码。
data.page_size	integer	每页数量。
data.list[].id	string	发布 ID。
data.list[].name	string	发布名称。
data.list[].source_database_id	string	源数据库 ID。
data.list[].mo_database_name	string	MatrixOne 中的源数据库名称。
data.list[].table_scope	object	已发布的表范围。
data.list[].table_scope.mode	string	表范围模式。
data.list[].table_scope.object_ids	string（字符串数组）	指定表的 ID；全部表模式时为空数组。
data.list[].obj_display_name	string	用于显示的源对象名称。
data.list[].obj_display_path	string	用于显示的源对象路径。
data.list[].targets	object（对象数组）	目标工作区列表。
data.list[].targets[].workspace_id	string	目标工作区 ID。
data.list[].targets[].workspace_name	string	目标工作区名称；有值时返回。
data.list[].permission	string	发布权限。
data.list[].remark	string	发布备注。
data.list[].created_by	string	创建者的显示名称；无法解析时返回创建者标识。
data.list[].created_at	string	创建时间。
data.list[].updated_at	string	最后更新时间。

错误响应

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

常见 HTTP 错误

HTTP 状态码	错误代码	常见原因	建议操作
400	ErrParamInvalid	分页或查询参数无法解析。	检查 page、page_size 和 keyword。
403	ErrPermissionDenied	当前身份没有读取发布的权限。	请求授予数据发布读取权限。
503	ErrServiceUnavailable	依赖服务暂不可用。	稍后重试。
500	ErrServer	服务端未能读取发布列表。	稍后重试。

后续操作

使用 data.list[].id 更新数据发布或删除数据发布。

最后更新于 2026 年 8 月 22 日