コンテンツにスキップ

無効化/有効化



POST /api/v1/data_query_rule/set_disable

概要

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

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

まず UUID と影響を受けるアイデンティティを確認してから、一括で送信してください。有効化/無効化はルールの status のみを変更し、元データは変更せず、実行中のクエリも取り消しません。無効化すると、そのルールは以降の範囲/マスキング計算に参加しなくなるため、最終的な権限を再検証する必要があります。true のみを返し、項目ごとの結果は提供しません。一部の UUID が無効でも、それを理由に 404 は返しません。

現在、すべてが一致しない場合([]、すべてが未知/ワークスペースをまたぐ/削除済みの UUID である場合を含む)、controller が監査コンテキストを設定せず、公開ルートがその後読み取ることで 500 が発生します。これは変更が発生したことを証明するものではありません。まず一覧から空でない有効な対象を取得し、エラー後は状態を再確認してください。

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

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

リクエストヘッダー

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

Body リクエストパラメータ

パラメータ名 型 必須 説明
queryRuleUuids[*] string 単一の空でない UUID。元の宣言では項目ごとの検証は行いません。
例: lqrl_example
取得または入力方法: 単一ルールの UUID。
isDisable boolean Y 必須の JSON ブール値。true は status=2 を保存し、false は 0 を保存します。削除済みルールは復元しません。
null を許可: False
例: true
取得または入力方法: ルールを一時停止する場合は true、再有効化する場合は false を使用します。
queryRuleUuids array Y 必須の配列。空でないことを推奨します。現在のワークスペース内の削除されていない一致項目のみを対象とし、ログモジュールではさらに logging に限定されます。
null を許可: False
例: ["lqrl_example"]
取得または入力方法: データアクセスルール一覧から対象 UUID の集合を取得します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/data_query_rule/set_disable' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"queryRuleUuids":["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 を提供してください。

フィードバック

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