統合カタログエンティティの一括削除¶
POST /api/v1/unified_catalog/entity/batch_delete
概要¶
URN リストに基づいて、現在のワークスペース内の統合カタログエンティティを一括削除します。
Body リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| urns | array | Y | 1〜500 個のエンティティ URN。先頭・末尾の空白を除去した後、空または重複があってはなりません 空を許可: False |
パラメータ補足説明¶
- urns は必須で、1 回につき 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"]}'