更新发布¶

更新数据发布的表范围、目标工作区或备注。

PUT https://api.moi.matrixorigin.cn/v5/data-share/publishes/{id}

调用前准备¶

先查询数据发布列表，确认要更新的发布。准备有目标工作区访问权限的个人访问令牌、目标工作区 ID 和发布 ID。

请求体¶

请求示例

curl -X PUT "https://api.moi.matrixorigin.cn/v5/data-share/publishes/$PUBLICATION_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  --data-binary @- <<JSON
{
  "table_scope": {
    "mode": "selected",
    "object_ids": ["${TABLE_ID}"]
  },
  "target_workspace_ids": ["${TARGET_WORKSPACE_ID}"],
  "remark": "更新后的备注"
}
JSON

参数说明

路径参数

字段	类型	必填	说明
`id`	integer	是	大于 `0` 的发布 ID。

请求体

字段	类型	必填	说明
`table_scope`	object	否	更新后的表范围。
`target_workspace_ids`	array of string	否	更新后的目标工作区 ID；提交时至少一个、不重复，不能包含当前工作区 ID，且每个值不能有首尾空白。
`remark`	string	否	更新后的备注。

只提交要修改的字段。

至少提交 table_scope、target_workspace_ids 或 remark 其中一个字段。

table_scope 对象

下面表格展开请求示例中的 table_scope 对象；每一行是该对象的一个字段。

字段	类型	必填	说明
`mode`	string	否	`all` 表示发布源数据库当前全部表；`selected` 表示仅发布 `object_ids` 中指定的表。
`object_ids`	array of string	否	`mode` 为 `selected` 时必须提供 1 至 1000 个不重复的正整数形式表 ID；`mode` 为 `all` 时必须省略或传空数组。

成功响应¶

响应示例

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "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"
      }
    ],
    "permission": "readonly",
    "remark": "更新后的备注",
    "created_by": "user-001",
    "created_at": "2026-08-18T10:00:00Z",
    "updated_at": "2026-08-18T11:00:00Z"
  }
}

字段说明

通用字段

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

发布信息

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

字段	类型	说明
`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.table_scope 对象；每一行是该对象的一个字段。

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

目标工作区

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

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

错误响应¶

响应示例

{
  "code": "ErrConcurrentUpdate",
  "msg": "资源状态冲突",
  "data": null
}

字段说明

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

后续操作¶

更新后查询数据发布列表确认发布定义。

最后更新于 2026 年 9 月 11 日