一覧取得¶
GET /api/v1/logging_query_rule/list
概要¶
ログアクセスルールとそのソースおよび有効/無効設定をページ単位で読み取ります。
呼び出し前と使用手順¶
現在のワークスペースの削除されていないルールを、無効な項目も含めて createAt の降順でクエリします。この公開エンドポイントは pageIndex/pageSize のみをサポートし、内部の search や effectiveRulesForCurAcnt はサポートしません。フロントエンドでのみ有効になるメンバー数や、メンバーおよびロールの展開は返しません。
ルールの保存は、以降に条件を満たすアイデンティティのデータクエリ範囲/結果のマスキングに影響します。元データの変更、削除、再収集は行わず、ロールの基本クエリ権限も追加しません。複数のロールおよびルールはクエリ側のポリシーに従ってマージされるため、単一のルールだけから最終的な権限を推測することはできません。Owner は免除され、管理者およびワークスペースの「データアクセス範囲の制限」設定は、一致するロールがない場合の処理を変更します。代表的なメンバーで実際にクエリして受け入れ確認してください。保存後はルールキャッシュが無効になり、進行中のすべてのクエリが即時に切り替わることは保証されません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| pageIndex | integer | 任意。デフォルトは1。最小値の宣言はありません。呼び出し元は正の整数を選択する必要があります。 null を許可: False 例: 1取得または入力方法: 1 から開始し、トップレベルの pageInfo に従って続行します。 |
|
| pageSize | integer | 任意。デフォルトは50。最大値の宣言はありません。ページサイズを小さくすると返却量は減りますが、現在の実装では一致するすべてのルールを先に読み取ってからページングするため、ページ単位での取得を推奨します。 null を許可: False 例: 50取得または入力方法: クライアントの処理能力に応じて、50 などの適切な正の整数を選択します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/logging_query_rule/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--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 | 保存値: 省略可能。未指定または空文字列の場合、呼び出し元アイデンティティの表示名および現在の Unix 秒に基づいて生成を試みます。変更時も同様に再生成され、以前の名前は保持されません。最大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 | 保存値: 明示的なブール値を推奨します。未指定時は無効として扱われます。無効な正規表現も構文が有効である必要があります。 |
| 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 | 1つの設定済みインデックスのワークスペースおよびインデックス情報。 |
| 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 では第1階層のキーでマージされ、未指定のキーは保持され、配列またはネストしたオブジェクトは全体が置き換えられます。{} は既存の 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 は独立したトップ固定インターフェースではありません。 |
| 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[].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.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": {}
}
],
"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 を提供してください。 |