作成¶
POST /api/v1/aggs_to_metric/add
概要¶
定期的に元データを集計し、新しいメトリクスを生成するルールを作成します。
呼び出し前の確認と使用手順¶
まず元データと q を検証し、重複しない出力 metric+metricField を定義したうえで、jsonScript と extend を完全に指定します。qtype=dql、qmode=selectorQuery および fieldKey/funcName を明示することを推奨します。手書きモードでは customQuery を明示し、extend は {} でもかまいません。新しいルールは既定で有効になり、その後は有効化/無効化 API で制御できます。
各ワークスペースでは、削除されていないすべての aggs ルール(無効なルールを含む)を対象に出力 metric+metricField をチェックします。重複があり skipRepeatNameCheck=false の場合、保存/変更は行われませんが、HTTP200、success=true を返しつつ、トップレベルの code=409、content.metricRepeat=true および英語の content.message が返されます。HTTP ステータスや success だけで判断せず、必ず code と metricRepeat を確認してください。skipRepeatNameCheck=true はこのチェックのみをスキップするものであり、同名の出力が互いに影響しないことを保証するものではありません。
Distribution モードを選択する場合、extend.funcName=distribution とし、q には histogram_auto(実際の数値フィールド) を使用します。フィールド値、グループ化、フィルターは実際にはすべて q に従い、extend が q を自動的に書き換えることはありません。unit は表示単位を付記するだけであり、数値変換はクエリまたは収集側で明確に処理する必要があります。
保存すると周期スケジュールが設定され、メトリクスの単位/説明が同期されますが、設定した集計 q が同期実行されたり、新しいメトリクスデータが生成されたりすることはありません。ただし、追加時にフィールド型を検証するため、ソースフィールドの Schema を同期的に照会する場合があります。後続タスクがいつ実行されるか、成功したか、メトリクスが書き込まれたかは、タスク/メトリクスの照会で確認する必要があります。スケジューリングサービスとデータベース/メトリクスメタデータは段階的に処理されるため、エラーやタイムアウト時には一部がすでに更新されている可能性があります。まずルールと対象メトリクスを読み取ってからリトライしてください。現在、この機能は無料プランのワークスペースには公開されていません。
リクエストヘッダ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| jsonScript.query.q | string | クエリオブジェクト内で必須の文字列です。選択モードでも完全な q を指定する必要があります。資格情報は入力しないでください。Distribution の例では histogram_auto(フィールド) を使用し、distribution(フィールド) ではありません。 例: L('default')::`nginx`:(count(`*`)) BY `host`取得または入力方法: DQL または PromQL の実際の構文に従って集計クエリを構築し、実際のログインデックス、ソース、フィールドを使用します。 |
|
| jsonScript.query.qtype | string | 任意のクエリ構文。省略時は既定の dql で実行されます。明示する場合は dql/promql のみで、空文字列や null は指定できません。常に明示的に入力することを推奨します。PromQL はインスタントクエリとして実行され、このオブジェクトでは rangeQuery を設定しません。 例: dql取得または入力方法: DQL の場合は dql、PromQL の場合は promql を入力します。 |
|
| jsonScript.query.qmode | string | 任意、明示を推奨します。selectorQuery は extend.fieldKey/funcName を要求し、customQuery はこれらのエコー用フィールドを要求しません。省略した場合、コントローラは選択モードの構造検証を実行しませんが、プラグインが選択モードとして関数を検証する可能性があるため、省略によって検証を回避することはできません。 例: selectorQuery取得または入力方法: コンソールの選択モードでは selectorQuery、手書きクエリでは customQuery を使用します。 |
|
| extend.funcName | string | selectorQuery の場合に条件付きで必須となる集計関数名。count はカウント、count_distinct は重複排除数。数値集計関数は実際の数値フィールドが必要です。distribution は q 内の histogram_auto に対応するエコーです。 例: count取得または入力方法: count/avg/max/sum/min/count_distinct/distribution/p75/p95/p99 から選択します。 |
|
| extend.fieldKey | string | selectorQuery の場合に条件付きで必須となる集計フィールドのエコー。追加時はソースフィールドの型を照会して数値関数の互換性をチェックしますが、未知のフィールドが必ず拒否されるわけではありません。変更時は同じフィールド型チェックを繰り返し実行しません。 例: *取得または入力方法: 元データのフィールドから実際のキーを取得します。カウントでは q に応じて*を使用できます。 |
|
| extend.source | string | 任意のソースエコー。すべての場合は*で表し、実際の範囲は引き続き q によって限定されます。RUM リストを照会する場合、この値から sourceInfo を付加できます。 例: nginx取得または入力方法: ログでは source、APM では service、RUM では app_id、メトリクスではメジャーメント、セキュリティでは category、Synthetic テストでは実際の Synthetic テストデータのソースを取得します。 |
|
| extend.index | string | 任意のログインデックスエコー。これを変更しても q 内の L インデックスは自動的に変更されません。 例: default取得または入力方法: 現在のワークスペースのログインデックス設定から取得します。既定のインデックスは通常 default です。 |
|
| extend.groupBy | array | 任意のグループ化エコー配列。省略時はこのエコーフィールドはありません。空配列はグループ化なしです。実際のグループ化は q に従います。 例: ["host"]取得または入力方法: q の BY グループ化、または PromQL のラベル集計から実際のフィールドを選択します。 |
|
| extend.groupBy[*] | string | 単一のグループ化キー。 例: host取得または入力方法: 元のフィールド名またはラベル名を取得します。 |
|
| extend.filterString | string | 任意のログフィルターエコー文字列。q を自動的に連結する入口ではありません。実際のフィルタリングは q に記述する必要があります。 例: env:production取得または入力方法: ログの選択モードでは、コンソールのフィルターから元の FilterString をコピーできます。 |
|
| extend.filters | array | 任意の配列。values は複数形で、他の API の value とは異なります。実際のフィルター実行は q に従います。 例: [{"name": "env", "condition": "and", "op": "=", "values": ["production"]}]取得または入力方法: ログ以外のセレクターで使用されるフィルターエコーです。 |
|
| extend.filters[*] | json | フィルターエコーオブジェクト。クライアントが持つ既存の形式を再帰的に保持できます。現在のエコー構造は実行クエリには変換されません。 例: {"name": "env", "condition": "and", "op": "=", "values": ["production"]}取得または入力方法: 各項目に 1 つのセレクター条件を保持します。 |
|
| extend.filters[*].name | string | エコーするフィールド。 例: env取得または入力方法: 実際のソースフィールド名。 |
|
| extend.filters[*].condition | string | 前のエコー条件との関係。 例: and取得または入力方法: and/or を使用します。省略時の表示慣例は and です。 |
|
| extend.filters[*].op | string | エコーする演算子。本 API ではクエリ条件の変換を実行しません。 例: =取得または入力方法: クライアントのセレクターに応じて =、!=、match、not match を使用します。 |
|
| extend.filters[*].values | array | エコーする値の配列。実際の比較と値の取得はすべて q に反映する必要があります。 例: ["production"]取得または入力方法: 元のフィールド値を使用し、文字列/数値/ブール型を保持します。 |
|
| extend.filters[*].values[*] | JSON | 単一の文字列、数値、またはブール値。 例: production取得または入力方法: ソースデータ内の単一のフィールド値を取得します。 |
|
| extend | json | Y | 必須のエコーオブジェクト。変更時は全体を置き換えます。すべてのエコーオプションは jsonScript.query の代わりになりません。手書きモードでエコーが不要な場合は {} を指定できます。 null を許可: False 例: {"funcName": "count", "fieldKey": "*", "source": "nginx", "index": "default", "groupBy": ["host"], "filters": [], "filterString": ""}取得または入力方法: クライアントエディターでのエコー用であり、すでに q に書き込んだ選択内容と一致させてください。 |
| jsonScript | json | Y | 必須のルールオブジェクト。変更時は全体を置き換え、フィールドのマージは行いません。本ページに記載されたサブフィールドのみを送信し、詳細レスポンスで返されるすべてのエンティティをそのまま返さないでください。 null を許可: False 例: {"type": "logToMetric", "query": {"q": "L('default')::`nginx`:(count(`*`)) BY `host`", "qtype": "dql", "qmode": "selectorQuery"}, "metricInfo": {"every": "5m", "metric": "recording_rules", "metricField": "nginx_requests"}}取得または入力方法: 元データのカテゴリ、クエリ文、出力メトリクスの定義に従って構築します。変更時はまず詳細から完全なオブジェクトを読み取ります。 |
| jsonScript.metricInfo | json | Y | 必須の出力とスケジュールのオブジェクト。変更時は全体を書き戻し、metric/metricField は変更できません。単位と説明は変更可能で、省略時は空文字列として同期されます。 null を許可: False 例: {"every": "5m", "metric": "recording_rules", "metricField": "nginx_requests", "unit": "custom/[\"custom\",\"次\"]", "desc": "按host统计nginx请求数。", "delaySeconds": 60}取得または入力方法: 業務側で出力メトリクスを定義します。まず既存のメトリクス生成ルールから重複がないか確認します。 |
| jsonScript.metricInfo.delaySeconds | integer | 任意の待機秒数。既定は 0 で遅延なしです。定期トリガー後にソースデータが揃うまで待機します。every に対応するクエリウィンドウは変更しません。このフィールドを指定しない場合、変更後は 0 に戻ります。JSON 整数である必要があり、ブール値や "60" 文字列は受け付けません。 選択可能値: [0, 60, 120, 180, 300, 600, 900, 1200, 1800] 例: 60取得または入力方法: 0/60/120/180/300/600/900/1200/1800 からのみ選択します。 |
|
| jsonScript.metricInfo.desc | string | 任意のメトリクス説明。省略/空文字列は空として同期されます。ルール名ではありません。 空文字列を許可: True 例: 按host统计nginx请求数。取得または入力方法: 出力メトリクスの意味、集計ロジック、単位の説明を入力します。 |
|
| jsonScript.metricInfo.every | string | Y | 必須の頻度。先頭に 0 を付けず、60m、0m、秒、日、Cron 式はサポートしません。スケジュール頻度とクエリウィンドウの長さに使用され、遅延時間ではありません。 空文字列を許可: False 例: 5m取得または入力方法: 生成頻度に応じて 1m~59m または 1h~24h を選択します。m/h は小文字です。 |
| jsonScript.metricInfo.metric | string | Y | 必須のメジャーメント名。英字、数字、アンダースコアのみで、ハイフン、スペース、中国語を含めることはできません。変更は許可されません。 空文字列を許可: False 例: recording_rules取得または入力方法: 出力メジャーメント名を独自に定義します。既存のメトリクス管理またはメトリクス生成一覧で名前を確認します。 |
| jsonScript.metricInfo.metricField | string | Y | 必須のメトリクス名。命名の文字制限は metric と同じです。変更は許可されません。過去の例にある 001-test を流用しないでください。 空文字列を許可: False 例: nginx_requests取得または入力方法: このメジャーメント配下の出力メトリクス名を定義します。ルール一覧で同じ metric+metricField を確認します。 |
| jsonScript.metricInfo.unit | string | 任意の表示単位文字列。省略/空文字列はクリアされます。単位に基づいて q の数値を自動変換することはなく、クエリ結果と単位が一致することを自身で保証する必要があります。 空文字列を許可: True 例: custom/["custom","次"]取得または入力方法: 単位説明を参照してください。標準形式は custom/["time","ms"]、カスタム形式は custom/["custom","単位"] です。 |
|
| jsonScript.query | json | Y | 必須のクエリオブジェクト。実際の実行は q に従い、extend フィールドからクエリを自動生成または修正することはありません。保存成功は、クエリ構文、データ可用性、生成結果が期待どおりであることを保証しません。 null を許可: False 例: {"q": "L('default')::`nginx`:(count(`*`)) BY `host`", "qtype": "dql", "qmode": "selectorQuery"}取得または入力方法: まず同じワークスペースのクエリツールで実際のデータ、集計結果、グループ化フィールドを検証します。 |
| jsonScript.type | string | Y | 必須のデータカテゴリ。公開宣言ではこの 6 種類のみを受け付けます。内部オブジェクトプラグインは、現在の OpenAPI が公開サポートしていることとは異なります。変更でカテゴリを変更することはできません。 空文字列を許可: False null を許可: False 選択可能値: ['logToMetric', 'rumToMetric', 'apmToMetric', 'metricToMetric', 'securityToMetric', 'dialingToMetric'] 例: logToMetric取得または入力方法: ログは logToMetric、RUM は rumToMetric、APM は apmToMetric、メトリクスは metricToMetric、セキュリティは securityToMetric、Synthetic テストは dialingToMetric です。 |
| skipRepeatNameCheck | boolean | 任意、既定は false です。true は同一ワークスペース内の削除されていない生成ルールの metric+metricField 重複チェックをスキップしますが、出力データが競合しないことを意味せず、命名/構造/スケジュールの検証を回避するものでもありません。 null を許可: False 例: false取得または入力方法: まずメトリクス生成ルール一覧で同じ出力メジャーメント+メトリクス名を確認します。通常は false です。 |
パラメータ補足説明¶
単位は単位説明を参照してください。元の extend と実際の query は一致している必要があり、生成頻度には every を使用し、Cron 式は送信しません。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/aggs_to_metric/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"jsonScript":{"type":"logToMetric","query":{"q":"L('"'"'default'"'"')::`nginx`:(count(`*`)) BY `host`","qtype":"dql","qmode":"selectorQuery"},"metricInfo":{"every":"5m","metric":"recording_rules","metricField":"nginx_requests","unit":"custom/[\"custom\",\"次\"]","desc":"按host统计nginx请求数。","delaySeconds":60}},"extend":{"funcName":"count","fieldKey":"*","source":"nginx","index":"default","groupBy":["host"],"filters":[],"filterString":""},"skipRepeatNameCheck":false}'
レスポンス¶
HTTP200、application/json の統一エンベロープ。正常時は code=200 でルールを返し、出力が重複する場合は code=409 でも success=true となるため、content.metricRepeat を確認する必要があります。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer または null | レコード番号。追加時のスナップショットは送信前に生成されるため null になる場合があり、その場合は uuid で操作します。 |
| content.uuid | string | rul_ ルールUUID。 |
| content.workspaceUUID | string | 所属ワークスペース。 |
| content.monitorUUID | string | 関連付けられたモニターUUID。本モジュールでは通常空文字列です。 |
| content.type | string | エンティティタイプは固定で aggs であり、jsonScript.type とは異なります。 |
| content.refKey | string | 関連キー。通常は空です。 |
| content.secret | string | 互換用のエンティティフィールド。通常のメトリクス生成ルールでは通常空です。呼び出し資格情報として使用したり、実際の値を記録したりしないでください。 |
| content.createdWay | string | manual/import/template または過去の空値。 |
| content.isLocked | integer または boolean | ロックフラグ。通常は 0/false です。 |
| content.openPermissionSet | boolean | カスタム操作権限のスイッチ。本モジュールでの作成時は通常 false です。 |
| content.permissionSet | array<string> |
カスタム操作主体の配列。通常は [] です。 |
| content.permissionSet[] | 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.crontabInfo | object | スケジュール設定のサマリー。タスク実行結果ではありません。 |
| content.crontabInfo.id | string | スケジュール設定の識別子。システム保守用であり、ルールの操作には uuid を使用します。 |
| content.crontabInfo.crontab | string | 実際の 6 セグメントのスケジュール式。例 0 */5 * * * *。リクエストの頻度には引き続き metricInfo.every を使用します。 |
| content.jsonScript | object | 保存された設定: 必須のルールオブジェクト。変更時は全体を置き換え、フィールドのマージは行いません。本ページに記載されたサブフィールドのみを送信し、詳細レスポンスで返されるすべてのエンティティをそのまま返さないでください。 |
| content.jsonScript.type | string | 保存された設定: 必須のデータカテゴリ。公開宣言ではこの 6 種類のみを受け付けます。内部オブジェクトプラグインは、現在の OpenAPI が公開サポートしていることとは異なります。変更でカテゴリを変更することはできません。 |
| content.jsonScript.query | json | 保存された設定: 必須のクエリオブジェクト。実際の実行は q に従い、extend フィールドからクエリを自動生成または修正することはありません。保存成功は、クエリ構文、データ可用性、生成結果が期待どおりであることを保証しません。 |
| content.jsonScript.query.q | string | 保存された設定: クエリオブジェクト内で必須の文字列です。選択モードでも完全な q を指定する必要があります。資格情報は入力しないでください。Distribution の例では histogram_auto(フィールド) を使用し、distribution(フィールド) ではありません。 |
| content.jsonScript.query.qtype | string | 保存された設定: 任意のクエリ構文。省略時は既定の dql で実行されます。明示する場合は dql/promql のみで、空文字列や null は指定できません。常に明示的に入力することを推奨します。PromQL はインスタントクエリとして実行され、このオブジェクトでは rangeQuery を設定しません。 |
| content.jsonScript.query.qmode | string | 保存された設定: 任意、明示を推奨します。selectorQuery は extend.fieldKey/funcName を要求し、customQuery はこれらのエコー用フィールドを要求しません。省略した場合、コントローラは選択モードの構造検証を実行しませんが、プラグインが選択モードとして関数を検証する可能性があるため、省略によって検証を回避することはできません。 |
| content.jsonScript.metricInfo | json | 保存された設定: 必須の出力とスケジュールのオブジェクト。変更時は全体を書き戻し、metric/metricField は変更できません。単位と説明は変更可能で、省略時は空文字列として同期されます。 |
| content.jsonScript.metricInfo.every | string | 保存された設定: 必須の頻度。先頭に 0 を付けず、60m、0m、秒、日、Cron 式はサポートしません。スケジュール頻度とクエリウィンドウの長さに使用され、遅延時間ではありません。 |
| content.jsonScript.metricInfo.metric | string | 保存された設定: 必須のメジャーメント名。英字、数字、アンダースコアのみで、ハイフン、スペース、中国語を含めることはできません。変更は許可されません。 |
| content.jsonScript.metricInfo.metricField | string | 保存された設定: 必須のメトリクス名。命名の文字制限は metric と同じです。変更は許可されません。過去の例にある 001-test を流用しないでください。 |
| content.jsonScript.metricInfo.unit | string | 保存された設定: 任意の表示単位文字列。省略/空文字列はクリアされます。単位に基づいて q の数値を自動変換することはなく、クエリ結果と単位が一致することを自身で保証する必要があります。 |
| content.jsonScript.metricInfo.desc | string | 保存された設定: 任意のメトリクス説明。省略/空文字列は空として同期されます。ルール名ではありません。 |
| content.jsonScript.metricInfo.delaySeconds | integer | 保存された設定: 任意の待機秒数。既定は 0 で遅延なしです。定期トリガー後にソースデータが揃うまで待機します。every に対応するクエリウィンドウは変更しません。このフィールドを指定しない場合、変更後は 0 に戻ります。JSON 整数である必要があり、ブール値や "60" 文字列は受け付けません。 |
| content.extend | object | 保存された設定: 必須のエコーオブジェクト。変更時は全体を置き換えます。すべてのエコーオプションは jsonScript.query の代わりになりません。手書きモードでエコーが不要な場合は {} を指定できます。 |
| content.extend.funcName | string | 保存された設定: selectorQuery の場合に条件付きで必須となる集計関数名。count はカウント、count_distinct は重複排除数。数値集計関数は実際の数値フィールドが必要です。distribution は q 内の histogram_auto に対応するエコーです。 |
| content.extend.fieldKey | string | 保存された設定: selectorQuery の場合に条件付きで必須となる集計フィールドのエコー。追加時はソースフィールドの型を照会して数値関数の互換性をチェックしますが、未知のフィールドが必ず拒否されるわけではありません。変更時は同じフィールド型チェックを繰り返し実行しません。 |
| content.extend.source | string | 保存された設定: 任意のソースエコー。すべての場合は*で表し、実際の範囲は引き続き q によって限定されます。RUM リストを照会する場合、この値から sourceInfo を付加できます。 |
| content.extend.index | string | 保存された設定: 任意のログインデックスエコー。これを変更しても q 内の L インデックスは自動的に変更されません。 |
| content.extend.groupBy | array | 保存された設定: 任意のグループ化エコー配列。省略時はこのエコーフィールドはありません。空配列はグループ化なしです。実際のグループ化は q に従います。 |
| content.extend.groupBy[] | string | 保存された設定: 単一のグループ化キー。 |
| content.extend.filterString | string | 保存された設定: 任意のログフィルターエコー文字列。q を自動的に連結する入口ではありません。実際のフィルタリングは q に記述する必要があります。 |
| content.extend.filters | array | 保存された設定: 任意の配列。values は複数形で、他の API の value とは異なります。実際のフィルター実行は q に従います。 |
| content.extend.filters[] | json | 保存された設定: フィルターエコーオブジェクト。クライアントが持つ既存の形式を再帰的に保持できます。現在のエコー構造は実行クエリには変換されません。 |
| content.extend.filters[].name | string | 保存された設定: エコーするフィールド。 |
| content.extend.filters[].condition | string | 保存された設定: 前のエコー条件との関係。 |
| content.extend.filters[].op | string | 保存された設定: エコーする演算子。本 API ではクエリ条件の変換を実行しません。 |
| content.extend.filters[].values | array | 保存された設定: エコーする値の配列。実際の比較と値の取得はすべて q に反映する必要があります。 |
| content.extend.filters[].values[] | JSON | 保存された設定: 単一の文字列、数値、またはブール値。 |
| content.__operation_info | object | 正常な追加レスポンスに付加される操作サマリー。リクエストパラメータではなく、重複分岐では返されません。 |
| content.__operation_info.uuid | string | 今回作成されたルールの UUID。content.uuid と一致します。 |
| content.declaration | object | ワークスペースの共通宣言。 |
| content.metricRepeat | boolean | 重複分岐の場合にのみ true で出現し、正常なルールエンティティの代わりになります。 |
| content.message | string | 重複分岐の場合にのみ出現するメッセージ。英語の値は例を参照してください。 |
| code | integer | 成功時は 200。重複分岐は 409 ですが HTTP は 200 のまま、success も true のままです。 |
| content.retryable | boolean | 503 QueryServiceUnavailable エラーの content にのみ true が出現する可能性があり、成功エンティティには含まれません。 |
{
"code": 200,
"content": {
"id": null,
"uuid": "rul_aggs_example",
"workspaceUUID": "wksp_example",
"monitorUUID": "",
"type": "aggs",
"refKey": "",
"secret": "",
"jsonScript": {
"type": "logToMetric",
"query": {
"q": "L('default')::`nginx`:(count(`*`)) BY `host`",
"qtype": "dql",
"qmode": "selectorQuery"
},
"metricInfo": {
"every": "5m",
"metric": "recording_rules",
"metricField": "nginx_requests",
"unit": "custom/[\"custom\",\"次\"]",
"desc": "按host统计nginx请求数。",
"delaySeconds": 60
}
},
"extend": {
"funcName": "count",
"fieldKey": "*",
"source": "nginx",
"index": "default",
"groupBy": [
"host"
],
"filters": [],
"filterString": ""
},
"crontabInfo": {
"id": "cron_example",
"crontab": "0 */5 * * * *"
},
"createdWay": "manual",
"isLocked": 0,
"openPermissionSet": false,
"permissionSet": [],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"declaration": {},
"__operation_info": {
"uuid": "rul_aggs_example"
}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
出力名が重複した場合、HTTP200:
{
"code": 409,
"content": {
"message": "Data duplication cannot be added",
"metricRepeat": true,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析に失敗しました | パラメータの位置、フィールド名、型、値を確認します。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正します。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトでない | 一部の json ファイルの形式エラー | 例に従って JSON オブジェクトを送信します。 |
| 403 | ft.InvalidMetricsName | メジャーメント名またはメトリクス名が英数字とアンダースコアの形式に準拠していない | メトリクス名には英数字とアンダースコアのみを含めることができます | metric/metricField を修正します。過去の例にあるハイフンを使用しないでください。 |
| 400 | ft.ParamsValidateError | query/metricInfo の構造、未知の jsonScript フィールド、頻度または遅延値が業務検証に違反、または選択モードで fieldKey/funcName が欠落 | パラメータ検証に失敗しました: {} | メッセージ内のフィールドパスを確認します。頻度と遅延は本ページの選択可能値のみを使用し、qmode と qtype を明示的に指定します。 |
| 400 | ft.OuterFuncFailed | スケジューリングサービスが明確な失敗を返却 | 外部関数呼び出しに失敗しました | 既存のルールとスケジュールを確認してからリトライします。失敗が続く場合は traceId を提供してください。 |
| 400 | ft.SameSetTraggerExists | スケジューリングサービスが同一設定を検出 | 同一設定のトリガーが既に存在します | 既存のルールとタスクを確認し、スケジュールの重複を避けます。 |
| 500 | ft.InternalServerError | 下流のタイムアウト/通常の 5xx、データベースまたは後続のメタデータ処理の失敗 | 内部エラー | まずルールとそのステータス、出力メトリクス、スケジュールの現状を読み取ってからリトライを判断します。traceId を提供してください。 |
| 406 | ft.UnsupportAggregateFunction | 追加時にプラグインが選択モードとして funcName を判定し、サポート集合に含まれない場合(qmode を省略したが extend が不完全な場合を含む) | サポートされていない集計関数 | qmode を明示的に入力し、選択モードでは有効な funcName を指定します。 |
| 406 | ft.FieldTypeUnsupportFunc | 追加時の選択モードで数値集計フィールドが数値型でないと確認された | この field {} 型 {} はこの計算関数 {} をサポートしていません | 数値フィールドまたは互換性のある集計関数を選択します。変更時は同じチェックを繰り返しません。 |
| 400 | ft.FiledCreateTrigger | 追加時のスケジュールが有効な id を返さない | トリガー設定の作成に失敗しました。再試行してください | まず既存のルール/スケジュールがあるか確認し、失敗が続く場合は traceId を提供してください。 |
| 503 | ft.QueryServiceUnavailable | 追加時にソースフィールドの型を照会する際にクエリサービスが 503 を返し、リトライ可能な 503 に正規化され、content.retryable=true となる | クエリサービスは一時的に利用できません。しばらくしてから再試行してください | バックオフしてリトライします。失敗が続く場合は traceId を提供してください。 |
| 429 | ft.KodoServerOverloaded | 追加時のフィールド照会が過負荷 | 現在のリクエストが頻繁すぎます。しばらくしてから再試行してください。 | バックオフしてリトライし、同時実行数を減らします。 |
| 403 | ft.Forbidden | API Key の権限不足、またはワークスペースのバージョンがこの機能をサポートしていない | この操作を行う権限がありません | 対応する権限を持つ API Key と、メトリクス生成をサポートするワークスペースを使用します。 |