查看发布列表¶

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

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

调用前准备¶

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

请求参数¶

请求示例

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

参数说明

参数

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

成功响应¶

响应示例

{
  "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": "readonly",
        "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
  }
}

字段说明

通用字段

字段	类型	说明
`code`	string	成功时为 `OK`。
`msg`	string	成功时为 `OK`。
`data`	object	响应数据。

分页信息

下面表格展开响应示例中 data 对象；每一行是该对象的一个字段。

字段	类型	说明
`list`	array of object	当前页发布列表；无结果时为空数组。
`total`	integer	匹配总数。
`page`	integer	当前页码。
`page_size`	integer	每页数量。

数据发布

下面表格展开响应示例中 data.list 数组的每一项；每一行是该数组项的一个字段。

字段	类型	说明
`id`	string	发布 ID。
`name`	string	发布名称。
`source_database_id`	string	源数据库 ID。
`mo_database_name`	string	MatrixOne 中的源数据库名称。
`table_scope`	object	已发布的表范围。
`obj_display_name`	string	用于显示的源对象名称。
`obj_display_path`	string	用于显示的源对象路径。
`targets`	array of object	目标工作区列表。
`permission`	string	固定为 `readonly`。
`remark`	string	发布备注。
`created_by`	string	创建者的显示名称；无法解析时返回创建者标识。
`created_at`	string	创建时间。
`updated_at`	string	最后更新时间。

表范围

下面表格展开响应示例中 data.list[].table_scope 对象；每一行是该对象的一个字段。

字段	类型	说明
`mode`	string	表范围模式。
`object_ids`	array of string	指定表的 ID；全部表模式时为空数组。

目标工作区

下面表格展开响应示例中 data.list[].targets 数组的每一项；每一行是该数组项的一个字段。

字段	类型	说明
`workspace_id`	string	目标工作区 ID。
`workspace_name`	string	目标工作区名称；有值时返回。

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

错误响应¶

响应示例

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

字段说明

字段	类型	说明
`code`	string	错误代码。
`msg`	string	错误说明。
`data`	null	错误时为空。

后续操作¶

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

最后更新于 2026 年 9 月 11 日