一覧取得¶
GET /api/v1/data_query_rule/list
概要¶
各種データアクセスルールとそのソース、および有効/無効設定をページングして読み取ります。
呼び出し前および使用手順¶
現在のワークスペースの未削除ルールを、無効な項目も含めて createAt の降順でクエリします。type は必ず明示する必要があります。role/index/source の各フィルターグループ間は AND、グループ内はいずれかに一致します。メンバー/ロールの概要を設定確認用に返しますが、各メンバーの最終的な有効権限を表すものではありません。
ルールの保存は、以降に条件を満たすアイデンティティのデータクエリ範囲/結果マスキングに影響します。元データの変更、削除、再収集は行わず、ロールの基本クエリ権限を追加するものでもありません。複数のロールおよびルールはクエリ側のポリシーでマージされるため、単一のルールだけで最終権限を推測することはできません。Owner は免除され、管理者およびワークスペースの「データアクセス範囲の制限」設定は、一致するロールがない場合の処理を変更します。代表的なメンバーで実際にクエリして検証してください。保存後はルールのキャッシュが無効になりますが、すべての実行中クエリが即座に切り替わることは保証できません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| indexUUIDs | commaArray | 任意。* を含むルールは自動的に一致します。現在、その他の項目は結合されたインデックス識別子に対する部分一致で、近似一致となる可能性があるため indexes を再確認してください。 null を許可: False 例: default取得または入力方法: ログインデックスの一覧から UUID/default を取得し、複数指定する場合は半角カンマで区切ります。 |
|
| isMask | string | 任意。maskFields が空文字列かどうかだけで判断し、正規表現が実際に有効であることや一致があることを意味しません。 null を許可: False 選択可能な値: ['true', 'false'] 例: true取得または入力方法: マスキングフィールドが設定されているものを抽出したい場合は文字列 true、それ以外は false。 |
|
| pageIndex | integer | 任意。デフォルト 1。宣言上は最小値がなく、呼び出し元は正の整数を選択する必要があります。 null を許可: False 例: 1取得または入力方法: 1 から開始し、トップレベルの pageInfo に従って続行します。 |
|
| pageSize | integer | 任意。デフォルト 50。宣言上の最大値はありません。ページサイズを小さくすると返却量は減りますが、現在の実装では先に一致するルールをすべて読み込んでからページングするため、ページ単位での取得を推奨します。 null を許可: False 例: 50取得または入力方法: クライアント容量に応じて 50 などの適切な正の整数を選択します。 |
|
| roleUUIDs | commaArray | 任意。いずれかのロールに一致する、または * を含むルールが対象です。JSON 配列ではありません。 null を許可: False 例: role_example取得または入力方法: ロール一覧から UUID を取得し、複数指定する場合は半角カンマで区切ります。 |
|
| search | string | 任意。name の部分一致で検索し、説明、フィールド、データは検索しません。 null を許可: True 例: production取得または入力方法: ルール名のキーワード。 |
|
| sources | commaArray | 任意。配列メンバーが、いずれかに完全一致するか * を含みます。他のフィルターとは AND で組み合わされます。 null を許可: False 例: monitor取得または入力方法: 対象ドメインの実際のソース値から取得し、複数指定する場合は半角カンマで区切ります。 |
|
| type | string | Y | Query 上は必須。通常の URL では JSON null で「すべて」を表現できないため、明示的に 1 つのタイプを選択してください。 null を許可: True 選択可能な値: ['lineage', 'keyevent', 'logging', 'rum', 'tracing', 'metric'] 例: logging取得または入力方法: logging/rum/tracing/metric/lineage/keyevent から対象のデータドメインを選択します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/data_query_rule/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode type=logging \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=50
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主なフィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> |
このページのルール。結果が空の場合は []。 |
| content.data[].id | integer または null | レコード番号。作成時は送信前スナップショットを返すため null の可能性があります。後続の操作には uuid を使用してください。 |
| content.data[].uuid | string | lqrl_ルールUUID。2 つのモジュールでエンティティと識別子を共有します。 |
| content.data[].workspaceUUID | string | このルールが属するワークスペース。ソースのワークスペースとは異なります。 |
| content.data[].status | integer | 0 は有効、2 は無効、3 は削除。このモジュールの読み取りでは未削除のみを対象とします。 |
| content.data[].creator | string | 作成者。 |
| content.data[].updator | string | 最終更新者。初期状態では空の場合があります。 |
| content.data[].createAt | integer | 作成日時の Unix 秒。 |
| content.data[].updateAt | integer | 更新日時の Unix 秒。未更新の場合は -1。 |
| content.data[].deleteAt | integer | 削除日時の Unix 秒。未削除の場合は -1。 |
| content.data[].name | string | 保存値: 宣言上は必須。空でない一意の名前を推奨。空文字列でも自動命名分岐に入る可能性があるため、この互換動作に依存しないでください。最大 64 文字カウント単位(ASCII/半角カタカナは 1、その他の文字は 2)。有効および無効の同タイプルールはどちらも重複名チェックの対象です。 |
| content.data[].desc | string | 保存値: 任意。最大 256 文字カウント単位(上記と同じ)。省略または空文字列の場合は空にクリアされます。変更時に元の値を保持するわけではありません。 |
| content.data[].indexes | array | 保存値: ログルールでは明確に指定する必要があります。宣言上は任意ですが、ログクエリには有効なインデックス範囲が必要で、省略して [] にしても自動的にすべてにはなりません。["*"] は利用可能なすべてのログインデックスを表します。* は単独で使用することを推奨します。[] はすべてを意味しません。keyevent では強制的に [] が保存され、その他の非ログタイプでは通常 [] を使用します。通常のインデックス名で UUID を置き換えることはできず、認可は自動作成されません。保存成功は、リモートのすべてのリソースが依然として有効であることを証明しません。 |
| content.data[].indexes[] | string | 保存値: 配列メンバーには空でない文字列を推奨します。元の宣言では項目ごとの強制はなく、誤った型は 500 を引き起こす可能性があります。 |
| content.data[].roleUUIDs | array | 保存値: 必須配列。["*"] は各ロールを表し、Owner は引き続きデータアクセス制限を受けません。[] はどのロールにも一致せず、すべてを意味しません。イベント keyevent は空でない文字列配列が必須で、* は単独でのみ出現できます。その他のタイプではスコープ内にロールが存在することを検証しますが、ロールの status=0 は保証しません。基本クエリ権限は別途必要です。 |
| content.data[].roleUUIDs[] | string | 保存値: 有効なロールを使用してください。アカウント UUID は使用しないでください。 |
| content.data[].conditions | string | 保存値: フィルター式のみを入力し、クエリ全体や外側の中括弧は入力しません。任意で、デフォルトは空文字列です。空文字列では追加の絞り込みを行いません。4048 文字以内を推奨します。keyevent では Python 文字数 ≤4048 で、かつ E クエリ構文を解析します。その他のタイプでは保存時に条件のセマンティクスを全面的に検証しないため、成功しても将来のクエリ成功を保証しません。このルールはアクセスを許可するデータ範囲を定義します。 |
| content.data[].extend | json | 保存値: 任意の JSON をそのまま返却可能。省略時は {}。統一された必須サブキーや単位はなく、サーバーはここから conditions を自動生成しません。変更時は全体を置き換えます。認証情報を保存しないでください。 |
| content.data[].extend.カスタムキー | any | 保存値: 任意のシリアライズ可能な JSON 値。追加で有効になる条件ではありません。 |
| content.data[].logic | string | 保存値: 互換性のための返却フィールドで、通常は and/or。任意です。省略時は空文字列を保存します。実際に有効なフィルターは conditions を直接使用し、logic を変更しても条件は書き換えられません。複数ロール/複数ルールのマージはこのフィールドでは制御されません。 |
| content.data[].maskFields | string | 保存値: 任意。省略時は空文字列で、このルールのフィールドマスキングは設定されません。変更時に省略するとクリアされます。フィールドが選択され、reExprs=[] の場合、非 null 値はフィールド全体が *** にマスクされます。空でない正規表現リストを指定した場合は有効な正規表現のみが適用され、すべて無効でもフィールド全体のマスキングにはなりません。保存用カラムに適合させるため 256 文字以下を推奨します。 |
| content.data[].reExprs | array | 保存値: 任意。省略時は []。変更時は全体を置き換えます。保存時に各正規表現を検証します(enable=false の項目も含む)。不正な正規表現は ft.ErrorRegularExpression を返します。単独の * を任意の文字列として使用せず、.* を使用してください。選択したフィールドに正規表現がない場合、フィールド全体が *** になります。正規表現は文字列内容の一致部分のみを処理し、一致内容を *** に置き換えます。保存時の検証と実行エンジンには差異があるため、保存成功後も代表的なクエリで検証する必要があります。 |
| content.data[].reExprs[] | json | 保存値: name/enable/reExpr のみを使用することを推奨します。配列要素は元の宣言で構造が強制されておらず、オブジェクト以外は 500 になる可能性があります。 |
| content.data[].reExprs[].name | string | 保存値: 任意の返却名。一致式としては使用されず、省略しても正規表現の一致には影響しません。 |
| content.data[].reExprs[].enable | boolean | 保存値: 明示的な boolean を推奨します。省略時は無効として扱われます。無効な正規表現も構文が有効である必要があります。 |
| content.data[].reExprs[].reExpr | string | 保存値: 空でない正規表現を推奨します。現在、省略時は空文字列としてチェックされるため、サーバーが有効な式を補完することに依存できません。 |
| content.data[].sources | array | 保存値: 非ログ範囲の配列。["*"] は利用可能なすべてのソースを表します。省略して [] にしてもすべてを意味しません。logging では強制的に [] が保存されます。rum/lineage では認可済みワークスペース UUID:ソース識別子で限定できます。tracing/metric/keyevent では元のソース文字列を使用します。keyevent は空でない文字列配列が必須で、wksp_:ソース を受け付けず、* を他の値と混在させることもできません。rum では現在の regionCode を明示した場合にのみ、アプリケーションの存在をクエリして確認します。その他のソースは保存に成功しても、実際にデータが存在することを証明しません。 |
| content.data[].sources[] | string | 保存値: 上位の type に従って解釈される単一のソース。空でない文字列を推奨します。 |
| content.data[].type | string | 保存値: 新規作成時は logging/rum/tracing/metric/lineage/keyevent が必須。宣言上は null を許可しますが、無効なタイプでは正常なクエリルールを形成できないため、常に上記の文字列を送信してください。変更時は type を受け付けず、保存済みのタイプを引き継ぎます。 |
| content.data[].regionCode | string | 保存値: v2 ではソースサイトコードが必須と宣言されています。同じルールのログインデックスは同一サイトに属し、この値と一致している必要があります。旧エントリではこのフィールドを受け付けません。データアクセスルールはクロスサイト/クロスワークスペースの認可を代替しません。イベントのクロスサイトには、keyevent または * を含む有効な認可が必要です。以下の重複ルートの実際の到達可能性に関する説明に注意してください。 |
| content.data[].indexWsInfo | string または object | ログルールのみ: * はすべてを表し、それ以外は元の indexes メンバーを動的キーとします。リソースが存在しない、または情報を取得できない場合、子オブジェクトは {} になることがあります。 |
| content.data[].indexWsInfo.インデックス識別子 | object | 設定済みインデックスのワークスペースおよびインデックス情報。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo | object | ソースワークスペース情報。空のオブジェクトの場合があります。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.uuid | string | ソースワークスペース UUID。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.name | string | ソースワークスペース名。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.status | integer | ワークスペース状態。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.regionCode | string | サイトコード。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.regionName | string または null | サイトのローカライズ名。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.datastore | object | 任意。各データタイプに対応するストレージカテゴリのマッピング。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.datastore.データタイプ | string | たとえば logging は scopedb に対応します。書き込み可能な設定ではありません。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.durationSet | object | 任意。各データタイプの保持期間。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.durationSet.データタイプ | string | 整数+d などの期間文字列。データドメインごとに区別されます。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.storagePolicy | object | ログのソースワークスペースにおける任意の長期ポリシーマッピング。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.storagePolicy.データタイプ | object | 対応するデータドメインの長期ポリシー。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.storagePolicy.データタイプ.isEnable | boolean | 長期ポリシーを有効にするかどうか。 |
| content.data[].indexWsInfo.インデックス識別子.wsInfo.storagePolicy.データタイプ.duration | string | 長期保持期間。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo | object | 通常のインデックスの完全なエンティティ、または default の合成サブセット。履歴/リモート情報ではフィールドが欠けることがあり、全体をそのまま書き戻さないでください。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.id | integer または null | データベースレコード番号。新規作成の送信前スナップショットでは null の可能性があります。操作には uuid を使用してください。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.uuid | string | lgim_インデックス設定UUID。デフォルトインデックスでは default を使用します。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.workspaceUUID | string | 所属ワークスペース。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.sourceIndexUUID | string | クローンインデックス B のソース A UUID。通常のインデックスでは空です。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.name | string | インデックス名。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.desc | string | 説明。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.conditions | string | extend に基づいて生成された実際の条件文字列。通常のリクエストではこのフィールドを直接変更しないでください。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.sortNo | integer または string | 一致順序の識別子。ネイティブ直接書き込みやクローンの場合は通常 0。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.duration | string | 標準ストレージ期間。TLS ではコールド/ホットアーカイブの合計日数です。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.isBindCustomStore | integer または boolean | 1/true は外部ストレージへのバインド。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.directIndex | integer または boolean | 1/true はネイティブ直接書き込み。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.isFullLineIndex | integer | 1 は全行、0 は Message。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.queryType | string | クエリカテゴリ。たとえば logging/standard、または外部 SLS が返すモード。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.exterStoreProject | string | 外部プロジェクト/データベース識別子。内部インデックスでは通常空です。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.exterStoreName | string | 外部リソース名。内部では通常空です。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.externalResourceAccessCfgUUID | string | アクセス設定識別子であり、認証情報の原文ではありません。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.storeType | string | 内部インデックスでは通常空。外部にバインドされている場合は実際のタイプ。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.region | string | 外部リージョンコード。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.isPublicNetworkAccess | integer または boolean | パブリックネットワークアクセスフラグ。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.status | integer | 0 は有効、2 は無効、3 は削除。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.creator | string | 作成者。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.updator | string | 最終更新者。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.createAt | integer | 作成日時の Unix 秒。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.updateAt | integer | 更新日時の Unix 秒。未更新の場合は -1。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.deleteAt | integer | 削除日時の Unix 秒。未削除の場合は -1。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.storagePolicy | object | 任意の完全な長期ポリシーオブジェクト。通常の新規作成では {} を省略します。変更時に省略した場合は保持され、{} は無効に正規化されます。明示的に無効化する場合は longStorageEnabled=false を使用します。長期期間は標準 duration より厳密に大きい必要があり、単位は引き続き日です。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.storagePolicy.longStorageEnabled | boolean | オブジェクト内で省略時はデフォルト false。無効にすると longStorageDuration は空に正規化されますが、過去のデータが直ちに削除されるわけではありません。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.storagePolicy.longStorageDuration | string | 有効時は条件付きで必須。フィールドは d を含む文字列で、秒/時間ではありません。メトリクス rp の 3600d 範囲をログに適用しないでください。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.setting | object | TLS の新規作成では hot_retention が必須。合計 duration は 3 つの時間数の合計を日数に換算します。通常の変更で setting を指定する場合は、ホットストレージおよび必要なステージを完全に提供し、cold_retention だけを送信しないでください。その他のストレージではこのフィールドを TLS として解釈しません。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.setting.hot_retention | integer | TLS では条件付きで必須。デフォルト範囲は 1~1800 日で、24..43200 時間に対応し、24 の倍数です。コールドストレージを使用する場合はホットストレージが少なくとも 7 日、アーカイブを使用する場合は少なくとも 30 日必要です。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.setting.cold_retention | integer | 任意。デフォルトは 30..1800 日で、1 日単位の時間数です。省略を 0 で表しません。合計は 1800 日を超えません。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.setting.archive_retention | integer | 任意。デフォルトは 60..1800 日で、1 日単位の時間数です。ホットストレージは少なくとも 30 日必要で、合計は 1800 日を超えません。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend | object | 任意の拡張オブジェクト。実際の一致設定および表示設定を含みます。通常の modify では第一階層のキーでマージされ、指定されていないキーは保持されます。配列またはネストしたオブジェクトは全体が置き換えられます。{} は既存の filters を消去しません。null は避けてください。一部の変更分岐では 500 になります。インポートの recover では extend 全体が置き換えられます。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.matchMode | string | 省略/空値の場合は basic。advanced では advancedFilter、basic では filters を使用します。モードを切り替える場合は対応する完全な条件も同時に指定してください。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.filters | array | basic のリーフ配列。空でない条件は conditions を生成します。新規作成/変更の basic では operation が match または not match の指定を明確に拒否します。テキスト包含などの複雑なセマンティクスには advanced の対応する演算を優先して使用してください。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.filters[].name | string | 実際のフィールド名。バッククォートを付けません。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.filters[].condition | string | 前の条件との and/or 関係。先頭項目の連結子は無視されます。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.filters[].operation | string | 一般的な =、!=、in、not_in、>、>=、<、<=、regexp、not_regexp、wildcard、not_wildcard、exist、not_exist。basic では match/not match は禁止です。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.filters[].value | array | 条件値の配列。= および比較では先頭項目を使用します。存在系でも空でないプレースホルダー配列を推奨します。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.filters[] | json | 条件オブジェクト。フィールド名/演算/値は完全である必要があります。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.filters[].value[] | JSON | 単一の比較値。表示名を実際の値の代わりに使用しないでください。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.advancedFilter | json | advanced 時に必須のルート group オブジェクト。グループは type=group、condition、filters を使用し、リーフは type=rule、name、operation、value を使用します。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.advancedFilter.type | string | ルートノードのタイプ。rule にはできません。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.advancedFilter.condition | string | 同じグループ内の子条件の論理関係。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.advancedFilter.filters | array | 子ノードの配列。同じ group 構造のネストを許可します。空のグループは空の条件を生成します。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.advancedFilter.filters[] | json | rule リーフまたは group オブジェクト。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.advancedFilter.filters[].type | string | rule はリーフ、group は再帰グループ。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.advancedFilter.filters[].name | string | rule では空でないフィールド名が必須。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.advancedFilter.filters[].operation | string | rule で許可されるのは =、!=、in、not_in、match、not_match、wildcard、not_wildcard、regexp、not_regexp、>、<、>=、<=、exist、not_exist。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.advancedFilter.filters[].value | array | rule では配列が必須。exist/not_exist では [] を使用できますが、それ以外では空配列を許可しません。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.advancedFilter.filters[].condition | string | group の子グループで and/or を使用します。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.advancedFilter.filters[].filters | array | group 子グループの再帰配列。ルールリーフでは省略します。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.advancedFilter.filters[].value[] | JSON | 単一の文字列または数値。regexp 値にはバッククォートを含めません。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.extendFields | array | 任意のキーフィールド配列。tag/alias 構造で送信し、tag は空でない必要があります。新規追加ではこの構造検証は強制されませんが、変更時には検証されます。インポートではフィールド高速化スイッチに従ってフィールドインデックスも同期され、直接 modify ではこの設定のみが保存されます。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.extendFields[] | json | tag/alias キーのみを許可します。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.extendFields[].tag | string | 条件付きで必須の空でないキー。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.extendFields[].alias | string | 任意の表示エイリアス。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.topFields | array | 任意の表示設定。同じ tag/alias オブジェクトを使用します。通常の modify は独立したトップ固定 API ではありません。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.topFields[] | json | 単一の表示フィールドオブジェクト。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.topFields[].tag | string | フィールドキー。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.topFields[].alias | string | 任意のエイリアス。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.services | array | 任意の返却情報。filters の実際の一致条件を代替しません。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.extend.services[] | string | 単一のサービス表示値。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.workspaceName | string | ソースワークスペース名。省略可能。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.workspaceStatus | integer | ソースワークスペース状態。省略可能。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.regionCode | string | ソースサイトコード。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.regionName | string または null | ソースサイト名。 |
| content.data[].indexWsInfo.インデックス識別子.indexInfo.grantStatus | integer | 任意。3 は現在認可が利用不可であることを表します。表示されていない場合でも、他のアクセス条件が満たされていることは保証されません。 |
| content.data[].sourcesWsInfo | string または object | 非ログルールのみ: * はすべてを表し、それ以外は sources の元のメンバーをキーとします。その他のタイプではソース名のみを表示し、リソースの存在を保証しません。 |
| content.data[].sourcesWsInfo.ソース識別子 | object | 1 つのソース概要。 |
| content.data[].sourcesWsInfo.ソース識別子.wsInfo | object | RUM ではソースワークスペース情報を持てます。その他のタイプでは通常 {}。 |
| content.data[].sourcesWsInfo.ソース識別子.wsInfo.uuid | string | ソースワークスペース UUID。 |
| content.data[].sourcesWsInfo.ソース識別子.wsInfo.name | string | ソースワークスペース名。 |
| content.data[].sourcesWsInfo.ソース識別子.wsInfo.status | integer | ワークスペース状態。 |
| content.data[].sourcesWsInfo.ソース識別子.wsInfo.regionCode | string | サイトコード。 |
| content.data[].sourcesWsInfo.ソース識別子.wsInfo.regionName | string または null | サイトのローカライズ名。 |
| content.data[].sourcesWsInfo.ソース識別子.wsInfo.datastore | object | 任意。各データタイプに対応するストレージカテゴリのマッピング。 |
| content.data[].sourcesWsInfo.ソース識別子.wsInfo.datastore.データタイプ | string | たとえば logging は scopedb に対応します。書き込み可能な設定ではありません。 |
| content.data[].sourcesWsInfo.ソース識別子.wsInfo.durationSet | object | 任意。各データタイプの保持期間。 |
| content.data[].sourcesWsInfo.ソース識別子.wsInfo.durationSet.データタイプ | string | 整数+d などの期間文字列。データドメインごとに区別されます。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo | object | RUM アプリケーションエンティティ、またはその他のタイプでは {name,status}。情報がない場合は {} になることがあります。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.name | string | 非 RUM ソースの元の名前。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.id | integer | アプリケーションレコード番号。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.uuid | string | appId と同じ。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.appId | string | RUM ソース識別子。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.workspaceUUID | string | アプリケーションが所属するワークスペース。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.clientToken | string | アプリケーション収集識別子。省略可能。このインターフェースの API Key ではなく、例では実際の値を出力しません。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.jsonContent | object | アプリケーション設定。タイプによって構造が異なります。RUM アプリケーション詳細の説明を使用してこのタイプを解釈してください。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.jsonContent.設定キー | JSON | このアプリケーションタイプで保存済みの設定(name/type など)。ここでは表示のみで、アクセスルールのパラメータではありません。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.status | integer | アプリケーション状態。履歴的に無効な場合があります。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.creator | string | 作成者。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.updator | string | 更新者。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.createAt | integer | 作成日時の Unix 秒。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.updateAt | integer | 更新日時の Unix 秒。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.deleteAt | integer | 削除日時の Unix 秒。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.workspaceName | string | ワークスペース名。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.workspaceStatus | integer | ワークスペース状態。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.regionCode | string | ソースサイトコード。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.regionName | string または null | ソースサイト名。 |
| content.data[].sourcesWsInfo.ソース識別子.sourcesInfo.grantStatus | integer | 任意。3 は認可が現在無効であることを表します。 |
| content.data[].creatorInfo | object | アイデンティティ概要。解決可能な情報がない場合は {}。 |
| content.data[].creatorInfo.uuid | string | アイデンティティ UUID。省略可能。 |
| content.data[].creatorInfo.status | integer | アカウント状態。省略可能。 |
| content.data[].creatorInfo.wsAccountStatus | integer | メンバー関係の状態。省略可能。 |
| content.data[].creatorInfo.name | string | 表示名。 |
| content.data[].creatorInfo.username | string | ログイン名。 |
| content.data[].creatorInfo.email | string | メールアドレスまたはシステムアイデンティティ識別子。 |
| content.data[].creatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].creatorInfo.countryCode | string | 国/地域コード。省略可能。 |
| content.data[].creatorInfo.iconUrl | string | アイコン URL。省略可能。 |
| content.data[].creatorInfo.acntWsNickname | string | このワークスペースでのニックネーム。省略可能。 |
| content.data[].updatorInfo | object | アイデンティティ概要。解決可能な情報がない場合は {}。 |
| content.data[].updatorInfo.uuid | string | アイデンティティ UUID。省略可能。 |
| content.data[].updatorInfo.status | integer | アカウント状態。省略可能。 |
| content.data[].updatorInfo.wsAccountStatus | integer | メンバー関係の状態。省略可能。 |
| content.data[].updatorInfo.name | string | 表示名。 |
| content.data[].updatorInfo.username | string | ログイン名。 |
| content.data[].updatorInfo.email | string | メールアドレスまたはシステムアイデンティティ識別子。 |
| content.data[].updatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].updatorInfo.countryCode | string | 国/地域コード。省略可能。 |
| content.data[].updatorInfo.iconUrl | string | アイコン URL。省略可能。 |
| content.data[].updatorInfo.acntWsNickname | string | このワークスペースでのニックネーム。省略可能。 |
| content.data[].relRoleInfos | array<object> |
読み取り時に一致したロール概要。* は有効な非 Owner ロールに展開され、指定ロールは履歴的な status または {} を返す場合があります。 |
| content.data[].relRoleInfos[] | object | 単一のロール概要。見つからない場合は {} になることがあります。 |
| content.data[].relRoleInfos[].uuid | string | ロール UUID。省略可能。 |
| content.data[].relRoleInfos[].name | string | ロール名。省略可能。 |
| content.data[].relRoleInfos[].status | integer | ロール状態。省略可能。 |
| content.data[].memberCount | integer | 現在のロール関連付けから推定したメンバー数。実際に制限されるクエリ数ではありません。ワイルドカード分岐では関連付け数から 1 を引くため、relMemberInfos の長さと一致しない場合があります。 |
| content.data[].relMemberInfos | array<object> |
解決可能なアイデンティティを持つ一致メンバー。* 分岐では Owner を除外します。 |
| content.data[].relMemberInfos[] | object | 解決可能な単一メンバーアイデンティティ。 |
| content.data[].relMemberInfos[].uuid | string | アイデンティティ UUID。省略可能。 |
| content.data[].relMemberInfos[].status | integer | アカウント状態。省略可能。 |
| content.data[].relMemberInfos[].wsAccountStatus | integer | メンバー関係の状態。省略可能。 |
| content.data[].relMemberInfos[].name | string | 表示名。 |
| content.data[].relMemberInfos[].username | string | ログイン名。 |
| content.data[].relMemberInfos[].email | string | メールアドレスまたはシステムアイデンティティ識別子。 |
| content.data[].relMemberInfos[].mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].relMemberInfos[].countryCode | string | 国/地域コード。省略可能。 |
| content.data[].relMemberInfos[].iconUrl | string | アイコン URL。省略可能。 |
| content.data[].relMemberInfos[].acntWsNickname | string | このワークスペースでのニックネーム。省略可能。 |
| content.data[].excludeOwnerRoleUUIDs | array<string> |
roleUUIDs に * が含まれる場合にのみ提供される、有効な非 Owner ロール UUID。 |
| content.data[].excludeOwnerRoleUUIDs[] | string | 単一のロール UUID。 |
| content.declaration | object | 共通宣言。 |
| pageInfo.pageIndex | integer | 現在のページ番号。 |
| pageInfo.pageSize | integer | ページサイズ。 |
| pageInfo.count | integer | このページの件数。 |
| pageInfo.totalCount | integer | 空でないページでは一致するルールの総数。現在、空のページは早期リターンするためこの値は 0 になり、範囲外ページの 0 は全体にルールがないことを証明できません。 |
{
"code": 200,
"content": {
"data": [
{
"id": 100,
"uuid": "lqrl_example",
"workspaceUUID": "wksp_example",
"name": "production_only",
"desc": "仅允许查看生产环境数据。",
"type": "logging",
"indexes": [
"default"
],
"sources": [],
"roleUUIDs": [
"role_example"
],
"conditions": "`env` = 'production'",
"extend": {},
"logic": "and",
"maskFields": "message",
"reExprs": [
{
"name": "token",
"enable": true,
"reExpr": "tkn_[0-9A-Za-z]+"
}
],
"regionCode": "",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"indexWsInfo": {
"default": {
"wsInfo": {},
"indexInfo": {}
}
},
"creatorInfo": {},
"updatorInfo": {},
"memberCount": 1,
"relRoleInfos": [
{
"uuid": "role_example",
"name": "生产查询",
"status": 0
}
],
"relMemberInfos": []
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 50,
"count": 1,
"totalCount": 1
}
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反した場合 | パラメータ解析失敗 | Query パラメータ表と例を確認してください。 |
| 404 | ft.NoInitOtherNodeCfg | リモートインデックス/RUM アプリケーションメタデータの読み取りまたは検証時に、利用可能なソースサイトアドレスが見つからなかった場合 | その他のノード設定が未初期化 | 管理者がソースサイト設定、アクセス可能なアドレス、および有効なクロスワークスペース認可を確認し、修正後に再試行してください。 |
| 500 | ft.InternalServerError | ルール、ロール、ソースワークスペース、またはインデックス/アプリケーションメタデータの読み取りとフォーマットに失敗した場合 | 内部エラー | 認可済みソースおよびサイト情報を更新し、しばらくしてから再試行してください。継続的に失敗する場合は traceId を提供してください。 |