跳转至

统一目录实体批量删除



POST /api/v1/unified_catalog/entity/batch_delete

概述

按 URN 清单批量删除当前工作空间内的统一目录实体。

Body 请求参数

参数名 类型 必选 说明
urns array Y 1–500 个实体 URN,去除首尾空白后不得为空或重复
允许为空: False

参数补充说明

  • urns 必填,单次 1–500 项,支持 urn:<类型>:<命名空间>:<名称> 和 <类型>:<名称>。
  • URN 去除首尾空白后不得为空或重复。参数全部校验后才执行删除。
  • 工作空间由 DF-API-KEY 鉴权确定,请求正文不能覆盖。
  • 清理目标实体全部入边、出边和自关联,不递归删除关联实体。
  • success 按请求顺序返回规范化 URN;successCount 包含原本不存在的实体,是处理数量而非实际删除行数。
  • 硬删除不受生命周期保护标记限制,后续上报可以重新创建实体。
  • 主存储失败返回整体错误,无部分成功列表;双写副存储失败不改变主存储成功结果,不提供跨引擎事务。
  • 超时可能发生在提交之后;调用方确认仍需删除相同目标后可重试,Studio 不自动重试。
  • 依赖 Kodo 提供 /v1/unified_catalog/entities/batch_delete。

请求例子

curl 'https://openapi.guance.com/api/v1/unified_catalog/entity/batch_delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"urns":["urn:service:default:api"]}'

响应

{
    "code": 200,
    "content": {
        "success": [
            "urn:service:default:api"
        ],
        "successCount": 1
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}

文档评价

文档内容是否对您有帮助?