削除¶
POST /api/v1/data_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 リクエストパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| queryRuleUuids[*] | string | 単一の空でない UUID。元の宣言では項目ごとの検証は行われません。 例: lqrl_example取得または入力方法: 単一ルールの UUID。 |
|
| queryRuleUuids | array | Y | 必須の配列で、空でないことを推奨します。現在のワークスペース内の削除されていない一致項目のみが対象で、ログモジュールではさらに logging に限定されます。 null の許可: False 例: ["lqrl_example"]取得または入力方法: データアクセスルール一覧から対象 UUID の集合を取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/data_query_rule/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"queryRuleUuids":["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 を提供してください。 |