コンテンツにスキップ

有効化/無効化



POST /api/v1/logging_query_rule/set_disable

概要

アクセスルールを一括で有効化/無効化します。

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

UUID と影響を受けるアイデンティティを確認してから一括送信してください。有効化/無効化はルールの status のみを変更し、元データは変更せず、進行中のクエリも取り消しません。無効化とは、そのルールが以降の範囲/マスキング計算に参加しなくなることを意味するため、最終的な権限を再検証する必要があります。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。
isDisable boolean Y 必須の JSON ブール値。true は status=2 を保存し、false は 0 を保存します。削除済みルールは復元しません。
null を許可: False
例: true
取得または入力方法: ルールを一時停止する場合は true、再度有効化する場合は false を使用します。
loggingQueryRuleUuids array Y 必須の配列。非空を推奨します。現在のワークスペースにある未削除の一致項目のみが対象で、ログモジュールではさらに logging に限定されます。
null を許可: False
例: ["lqrl_example"]
取得または入力方法: ログアクセスルール一覧から対象の UUID 集合を取得します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/logging_query_rule/set_disable' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"loggingQueryRuleUuids":["lqrl_example"],"isDisable":true}'

レスポンス

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 を提供してください。

フィードバック

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