削除¶
POST /api/v1/blacklist/delete
概要¶
現在のワークスペースのブラックリストルールをソフト削除します。
呼び出し前の確認と使用手順¶
まず一覧で各 UUID、ルール名、およびその範囲を確認してから、文字列配列を送信してください。サーバーは現在のワークスペース内で削除されていない一致項目のみを処理します。空配列、すべて未知の UUID、または別ワークスペースの UUID であっても true を返す場合があり、項目ごとの一致結果は提供されません。
本 API はルールをソフト削除します(status=3)。過去データの復元はトリガーしません。成功後は項目ごとに再読み取りするか一覧を確認し、true を実際の削除件数とみなさないでください。これはブラックリストルール設定用の API であり、過去データ削除用の API ではありません。保存時の戻り値はルールレコードの処理完了のみを示し、下流の収集/処理チェーンの反映状況や通知結果は提供しません。本番適用前に、管理されたサンプルで実際のフィルタ範囲を確認し、ソース/条件のない広範囲ルールを避けてください。無料プランのワークスペースは本グループの宣言で制限されるため、この機能をサポートするワークスペースと対応する API Key 権限を使用する必要があります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| blacklistUUIDs[*] | string | 文字列要素です。null、数値、オブジェクトを渡さないでください。strip 処理で 500 になる可能性があります。 例: blist_example取得・入力方法: ブラックリスト一覧から単一ルールの uuid を取得します。 |
|
| blacklistUUIDs | array | Y | 必須のルール UUID 配列であり、カンマ区切り文字列ではありません。サーバーは各項目の先頭と末尾の空白を除去し、空文字列を無視します。一致しない UUID は一部の一括操作で無視されるため、引き続き項目ごとに確認が必要です。 null 許可: False 例: ["blist_example"]取得・入力方法: ブラックリスト一覧から実際の uuid を取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/blacklist/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"blacklistUUIDs":["blist_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 成功時は true です。すべての UUID が一致したことや、状態変更が発生したことを示すものではありません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の json ファイルの形式エラー | パラメータ表の JSON オブジェクトを送信してください。 |
| 500 | ft.InternalServerError | データベース、ストレージの長さ/null、フィールド形状、または後続処理の異常 | 内部エラー | まずルールとその設定を照会してから再試行を判断してください。継続的に失敗する場合は traceId を保持してください。 |
| 403 | ft.Forbidden | API Key にこの操作権限がない、またはワークスペースのバージョンがブラックリスト機能をサポートしていない | 操作する権限がありません | 対応する権限の API Key と、この機能をサポートするワークスペースを使用してください。 |