コンテンツにスキップ

削除



POST /api/v1/logging_query_rule/delete

概要

アクセスルールを一括でソフト削除します。

呼び出し前の確認と使用手順

まず UUID と影響を受けるアイデンティティを確認してから、一括で送信してください。ルールをソフト削除するだけで、ソースデータは削除されず、ロールの基本クエリ権限の取り消しを意味するものでもありません。削除後は本モジュールの get で読み取ることはできず、有効化インターフェースによる復元もできません。true のみを返し、項目ごとの結果は提供しません。一部の UUID が無効でも、それによって 404 が返ることはありません。空の配列やすべてが一致しない場合も true で成功しますが、実際のヒット件数を示すものではありません。

書き込みは設定の置き換えとデータベースへのコミットを行い、その後ルールキャッシュをクリアして監査を記録します。クロスサイト検証ではリソース情報の読み取り/更新が発生する場合があります。この手順は単一のアトミックトランザクションではありません。500 やタイムアウトが発生した場合は、まず一覧/詳細で保存済みかどうかを確認し、むやみに再追加しないでください。

ルールの保存は、以降に条件へ一致するアイデンティティのデータクエリ範囲/結果マスキングに影響しますが、生データの変更、削除、再収集は行わず、ロールの基本クエリ権限も追加しません。複数のロールおよびルールはクエリ側のポリシーに従ってマージされるため、単一のルールだけから最終的な権限を推測することはできません。Owner は免除され、管理者およびワークスペースの「データアクセス範囲制限」設定は、一致するロールがない場合の処理を変更します。代表的なメンバーで実際にクエリして受け入れ確認を行ってください。保存後はルールキャッシュが無効になりますが、すべての実行中クエリが即座に切り替わることを保証するものではありません。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
loggingQueryRuleUuids[*] string 単一の非空 UUID。元の宣言では項目ごとの検証を行っていません。
例: lqrl_example
取得または入力方法: 単一ルールの UUID。
loggingQueryRuleUuids array Y 必須の配列。空でないことを推奨します。現在のワークスペースの未削除の一致項目のみで、ログモジュールではさらに logging に限定されます。
null を許可: False
例: ["lqrl_example"]
取得または入力方法: ログアクセスルール一覧から対象 UUID の集合を取得します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/logging_query_rule/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"loggingQueryRuleUuids":["lqrl_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 を修正してください。
500 ft.InternalServerError 配列項目の形状不一致、フィールドの保存長超過、下流の通常 5xx、データベースまたはコミット後のキャッシュ失敗 内部エラー 本文の構造と長さを確認し、現在の設定を読み取ってデータベースに保存済みかどうかを確認してから再試行を判断し、traceId を提供してください。

フィードバック

このページは役に立ちましたか?