変更¶
POST /api/v1/aggs_to_metric/{rule_uuid}/modify
概要¶
メトリクス生成ルールのクエリ、頻度、遅延、表示設定を変更します。
呼び出し前と使用手順¶
まず詳細を読み取り、完全な jsonScript と extend を戻したうえで変更します。jsonScript.type、metricInfo.metric、metricInfo.metricField は変更できません。出力名または種類を変更する必要がある場合は、新しいルールの作成と旧ルールの無効化を検討してください。変更は全体置き換えで、unit/desc を省略すると表示メタデータがクリアされ、delaySeconds を省略すると 0 に戻ります。旧 extend にのみ存在するフィールドは保持されません。
各ワークスペースでは、無効化されたルールを含む、削除されていないすべての aggs ルールを対象に出力 metric+metricField をチェックします。重複があり skipRepeatNameCheck=false の場合、保存/変更は行われませんが、HTTP 200、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 を同期的に照会する場合があります。後続のジョブがいつ実行されるか、成功したか、メトリクスが書き込まれたかは、ジョブ/メトリクスのクエリで確認する必要があります。スケジュールサービスとデータベース/メトリクスメタデータは段階的に処理されるため、エラーやタイムアウト時には一部がすでに更新されている可能性があります。ルールと対象メトリクスを先に読み取ってから再試行してください。現在、この機能は無料プランのワークスペースには公開されていません。
また、変更により既存のカスタム操作権限が openPermissionSet=false、permissionSet=[] にリセットされます。事前に過去の権限設定を確認してください。
これらの入口は共通のルール処理を共有しており、一部の対象クエリでは type=aggs が追加で限定されていません。ほかのルールを誤って読み取ったり変更したりしないよう、本モジュールの一覧が返す UUID のみを使用してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| rule_uuid | string | Y | パス内のルール UUID。メトリクス名、メジャーメント名、スケジュール ID ではありません。通常のモニターの rul_ UUID を渡さないでください。 例: rul_aggs_example取得または入力方法: メトリクス生成ルール一覧の content.data[].uuid からのみ、本ワークスペースの aggs ルールを取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエストボディパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 | 任意の配列。ほかのインターフェースの value と区別するため、複数形の values を使用します。実際に実行されるフィルターは 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 | エコー演算子。本インターフェースではクエリ条件の変換を実行しません。 例: =取得または入力方法: クライアントのセレクターに従って =、!=、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/rul_aggs_example/modify' \
-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}'
レスポンス¶
HTTP 200、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 | 保存された設定:任意の配列。ほかのインターフェースの value と区別するため、複数形の values を使用します。実際に実行されるフィルターは q に従います。 |
| content.extend.filters[] | json | 保存された設定:フィルターエコーオブジェクト。クライアントの既存形式を再帰的に保持できます。現在のエコー構造は実行クエリに変換されません。 |
| content.extend.filters[].name | string | 保存された設定:エコーフィールド。 |
| content.extend.filters[].condition | string | 保存された設定:直前のエコー条件との関係。 |
| content.extend.filters[].op | string | 保存された設定:エコー演算子。本インターフェースではクエリ条件の変換を実行しません。 |
| content.extend.filters[].values | array | 保存された設定:エコー値の配列。実際の比較と値の取得はすべて q に反映する必要があります。 |
| content.extend.filters[].values[] | JSON | 保存された設定:単一の文字列、数値、またはブール値。 |
| content.declaration | object | ワークスペースの共通宣言。 |
| content.metricRepeat | boolean | 重複分岐でのみ true が出現し、通常のルールエンティティに代わります。 |
| content.message | string | 重複分岐でのみメッセージが出現します。英語の値は例を参照してください。 |
| code | integer | 成功時は 200。重複分岐では 409 ですが HTTP は 200 のままで、success も true のままです。 |
{
"code": 200,
"content": {
"id": 101,
"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": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427300,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
出力名が重複する場合、HTTP 200:
{
"code": 409,
"content": {
"message": "Data duplication cannot be modified",
"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 を提供してください。 |
| 404 | ft.NotFoundRuleInspector | 対象ルールが存在しない/削除済み/別ワークスペース | 指定されたルール/インスペクターが見つかりません | 本モジュールの一覧から UUID を再取得します。 |
| 400 | ft.NotSupportModifyAggsToMetricRuleType | リクエストの type が既存ルールの jsonScript.type と異なる | メトリクス生成ルールの種類変更はサポートしていません | 元の種類を戻してください。別のカテゴリが必要な場合は新しいルールを作成します。 |
| 400 | ft.NotSupportModifyAggsToMetricRuleMetricField | metric または metricField が元のルールと異なる | メトリクス生成のメジャーメント/メトリクス情報の変更はサポートしていません | 元の出力名を保持してください。名前を変更する場合は、新しいルールの作成と旧ルールの無効化を検討します。 |
| 403 | ft.Forbidden | API Key の権限不足、またはワークスペースのプランがこの機能をサポートしていない | 操作権限がありません | 対応する権限を持つ API Key と、メトリクス生成をサポートするワークスペースを使用します。 |