有効化/無効化¶
POST /api/v1/blacklist/batch_set_disable
概要¶
現在の公開コントラクトに従って、ブラックリストルールを一括で有効化します。
呼び出し前の確認と使用手順¶
まず一覧で各 UUID、ルール名、およびその範囲を確認してから、文字列配列を送信してください。サーバーは現在のワークスペース内の未削除の一致項目のみを処理します。空の配列、すべて未知の UUID、またはワークスペースをまたぐ UUID の場合でも true が返ることがあり、項目ごとの一致結果は提供されません。
現在の公開 Body には blacklistUUIDs のみが宣言されており、isDisable はありません。このフィールドを送信しない場合、ルートはデフォルトで false になるため、現在の公開リクエストでは無効化されたルールを status=0 に戻すことができます。isDisable=true を送信すると未知のフィールド検証で拒否されるため、ページ上の過去の名称に基づいて完全な無効化機能を保証することはできません。無効化が必要な場合はコンソールを使用してください。有効化済みのレコードはそのまま維持され、削除済みのレコードは復元されません。これはブラックリストルールの設定インターフェースであり、履歴データの削除インターフェースではありません。保存時のレスポンスはルールレコードの処理が完了したことのみを示し、下流の収集/処理パイプラインの反映状況や通知結果は提供しません。本番適用前に、制御されたサンプルで実際のフィルタ範囲を確認し、ソースや条件のない広範なルールを避けてください。無料プランのワークスペースはこのグループの宣言では制限されているため、この機能をサポートするワークスペースと適切な 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/batch_set_disable' \
-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 と、この機能をサポートするワークスペースを使用してください。 |