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