一覧表示¶
GET /api/v1/aggs_to_metric/list
概要¶
現在のワークスペースのメトリクスを生成するルール、出力定義、スケジュール、有効/無効状態をページングして一覧表示します。
呼び出し前の準備と使用手順¶
まず scriptType でデータカテゴリを選択し、次に metric/metricField で検索してページごとに読み取ります。クエリ対象は type=aggs かつ status!=3 のみで、無効なルールも含まれ、レコード ID の降順で並びます。RUM アプリケーション情報は、scriptType=rumToMetric を明示した場合にのみ extend.sourceInfo への補完を試みます。タイプを指定せずに全件をクエリしても、各 RUM に対して自動的に補完されることはありません。
一覧内の設定はルールのスナップショットであり、実行状態やメトリクスを生成した結果ではありません。後続の変更では、このインターフェースの書き込みフィールドに従って完全な Body を構築する必要があります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| pageIndex | integer | 任意。デフォルトは 1、最小値は 1 です。 null を許可: False $minValue: 1 例: 1取得または入力方法: 1 から開始し、トップレベルの pageInfo に従って進めます。 |
|
| pageSize | integer | 任意。デフォルトは 100、最大値は 100 です。 null を許可: False $maxValue: 100 $minValue: 1 例: 100取得または入力方法: 1 ページあたり 1 から 100 を選択します。 |
|
| scriptType | string | 任意のタイプフィルターです。現在の Query 列挙には objectToMetric/customObjectToMetric が含まれません。過去のこの種のレコードはフィルターなしの一覧で確認できますが、これに基づいて現在作成可能と判断しないでください。 null を許可: False 選択可能な値: ['rumToMetric', 'apmToMetric', 'logToMetric', 'securityToMetric', 'metricToMetric', 'dialingToMetric'] 例: logToMetric取得または入力方法: 公開されている 6 種類の jsonScript.type から選択します。省略した場合はすべての aggs をクエリします。 |
|
| search | string | 任意。前後の空白を除去した後、メジャーメント名/メトリクス名の部分一致で検索します。ルール UUID や extend は検索しません。 空文字列を許可: True null を許可: False 例: nginx_requests取得または入力方法: 出力 metric または metricField のキーワードを指定します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/aggs_to_metric/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode scriptType=logToMetric \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=100
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> |
このページのルール配列です。結果が空の場合は [] です。 |
| content.data[].id | integer または null | レコード番号です。新規スナップショットは送信前に生成されるため null の可能性があり、uuid で操作します。 |
| content.data[].uuid | string | rul_ ルール UUID。 |
| content.data[].workspaceUUID | string | 所属ワークスペース。 |
| content.data[].monitorUUID | string | 関連付けられたモニターの UUID。このモジュールでは通常空文字列です。 |
| content.data[].type | string | エンティティタイプは固定で aggs です。jsonScript.type とは異なります。 |
| content.data[].refKey | string | 関連キー。通常は空です。 |
| content.data[].secret | string | 互換性のためのエンティティフィールドです。通常のメトリクスを生成するルールでは通常空です。呼び出し資格情報として使用したり、実際の値を記録したりしないでください。 |
| content.data[].createdWay | string | manual/import/template または過去の空値。 |
| content.data[].isLocked | integer または boolean | ロックフラグ。通常は 0/false です。 |
| content.data[].openPermissionSet | boolean | カスタム操作権限のスイッチ。このモジュールで作成する場合は通常 false です。 |
| content.data[].permissionSet | array<string> |
カスタム操作の主体の配列。通常は [] です。 |
| content.data[].permissionSet[] | 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[].crontabInfo | object | スケジュール設定のサマリーです。タスク実行結果ではありません。 |
| content.data[].crontabInfo.id | string | スケジュール設定の識別子です。システムの保守用であり、ルールの操作には uuid を使用します。 |
| content.data[].crontabInfo.crontab | string | 実際の 6 フィールドのスケジュール式です。例: 0 */5 * * * *。リクエスト頻度には引き続き metricInfo.every を使用します。 |
| content.data[].jsonScript | object | 保存された設定: 必須のルールオブジェクトです。変更時は全体を置き換え、フィールドのマージは行いません。このページに記載されたサブフィールドのみを送信し、詳細レスポンスで返されるエンティティ全体を送り返さないでください。 |
| content.data[].jsonScript.type | string | 保存された設定: 必須のデータカテゴリです。公開されている宣言ではこの 6 種類のみを受け付けます。内部のオブジェクトプラグインは、現在の OpenAPI で公開サポートされていることを意味しません。変更時にカテゴリを変更することはできません。 |
| content.data[].jsonScript.query | json | 保存された設定: 必須のクエリオブジェクトです。実際の実行は q に基づきます。extend フィールドからクエリを自動生成または修正することはありません。保存の成功は、クエリ構文、データの可用性、または生成結果が期待どおりであることを保証しません。 |
| content.data[].jsonScript.query.q | string | 保存された設定: クエリオブジェクト内で必須の文字列です。選択モードでも完全な q を指定する必要があります。資格情報を入力しないでください。Distribution の例では histogram_auto(フィールド) を使用し、distribution(フィールド) は使用しません。 |
| content.data[].jsonScript.query.qtype | string | 保存された設定: オプションのクエリ構文です。省略時はデフォルトで dql を実行します。明示する場合は dql/promql のみを使用でき、空文字列や null は指定できません。常に明示的に指定することを推奨します。PromQL は即時クエリとして実行され、このオブジェクトで rangeQuery を設定することはできません。 |
| content.data[].jsonScript.query.qmode | string | 保存された設定: オプションですが、明示を推奨します。selectorQuery では extend.fieldKey/funcName が必要です。customQuery ではこれらの返却フィールドは要求されません。省略時、コントローラーは選択モードの構造検証を実行しませんが、プラグインは引き続き選択モードに従って関数を検証する場合があります。省略によって検証を回避することはできません。 |
| content.data[].jsonScript.metricInfo | json | 保存された設定: 必須の出力およびスケジュールオブジェクトです。変更時は全体を書き戻します。metric/metricField は変更できません。単位の説明は変更可能で、省略すると空文字列として同期されます。 |
| content.data[].jsonScript.metricInfo.every | string | 保存された設定: 必須の頻度です。先頭に 0 は付けず、60m、0m、秒、日、Cron 式はサポートしません。スケジュール頻度とクエリウィンドウの長さに使用され、遅延時間ではありません。 |
| content.data[].jsonScript.metricInfo.metric | string | 保存された設定: 必須のメジャーメント名です。英字、数字、アンダースコアのみ使用でき、ハイフン、空白、中国語は含められません。変更時に変更することはできません。 |
| content.data[].jsonScript.metricInfo.metricField | string | 保存された設定: 必須のメトリクス名です。命名時の文字制限は metric と同じです。変更時に変更することはできません。過去の例にある 001-test を使用しないでください。 |
| content.data[].jsonScript.metricInfo.unit | string | 保存された設定: オプションの表示単位文字列です。省略または空文字列の場合はクリアされます。単位に基づいて q の数値を自動変換することはないため、クエリ結果と単位が一致することを自身で保証する必要があります。 |
| content.data[].jsonScript.metricInfo.desc | string | 保存された設定: オプションのメトリクス説明です。省略または空文字列の場合は空として同期されます。ルール名ではありません。 |
| content.data[].jsonScript.metricInfo.delaySeconds | integer | 保存された設定: オプションの待機秒数です。デフォルトは 0 で遅延しません。定期トリガー後にソースデータが揃うまで待機します。every に対応するクエリウィンドウは変更しません。このフィールドを指定しない場合、変更後は 0 に戻ります。JSON 整数である必要があり、ブール値や "60" 文字列は受け付けません。 |
| content.data[].extend | object | 保存された設定: 必須の返却オブジェクトです。変更時は全体を置き換えます。すべての返却オプションは jsonScript.query の代替ではありません。手書きモードで返却が不要な場合は {} を指定できます。 |
| content.data[].extend.funcName | string | 保存された設定: selectorQuery 時に条件付きで必須となる集計関数名です。count は件数、count_distinct は重複排除数です。数値集計関数には実際の数値フィールドが必要です。distribution の返却値は q 内の histogram_auto に対応します。 |
| content.data[].extend.fieldKey | string | 保存された設定: selectorQuery 時に条件付きで必須となる集計フィールドの返却値です。新規追加時はソースフィールドの型を照会して数値関数との互換性を確認しますが、未知のフィールドが必ず拒否されるとは限りません。変更時は同じフィールド型チェックを繰り返し実行しません。 |
| content.data[].extend.source | string | 保存された設定: オプションのソース返却値です。すべて利用可能な場合は * で表され、実際の範囲は引き続き q によって制限されます。RUM 一覧をクエリする場合、この値によって sourceInfo を追加できます。 |
| content.data[].extend.index | string | 保存された設定: オプションのログインデックスの返却値です。これを変更しても、q 内の L インデックスは自動的に変更されません。 |
| content.data[].extend.groupBy | array | 保存された設定: オプションのグループ化返却配列です。省略時はこの返却フィールドはありません。空配列はグループ化しません。実際のグループ化は q に基づきます。 |
| content.data[].extend.groupBy[] | string | 保存された設定: 単一のグループ化キーです。 |
| content.data[].extend.filterString | string | 保存された設定: オプションのログフィルター返却文字列です。q を自動的に結合するための入力ではありません。実際のフィルタリングは q に記述する必要があります。 |
| content.data[].extend.filters | array | 保存された設定: オプションの配列です。複数形の values を使用し、他のインターフェースの value とは異なります。実際のフィルター実行は q に基づきます。 |
| content.data[].extend.filters[] | json | 保存された設定: フィルター返却オブジェクトです。クライアントが既に持つ形式を再帰的に保持できます。現在の返却構造は実行クエリに変換されません。 |
| content.data[].extend.filters[].name | string | 保存された設定: 返却フィールド。 |
| content.data[].extend.filters[].condition | string | 保存された設定: 直前の返却条件との関係。 |
| content.data[].extend.filters[].op | string | 保存された設定: 返却演算子です。このインターフェースではクエリ条件の変換を実行しません。 |
| content.data[].extend.filters[].values | array | 保存された設定: 返却値の配列です。実際の比較と値の取得はすべて q に反映する必要があります。 |
| content.data[].extend.filters[].values[] | JSON | 保存された設定: 単一の文字列、数値、またはブール値。 |
| 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 | アバター。省略可能です。 |
| 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 | アバター。省略可能です。 |
| content.data[].updatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略可能です。 |
| content.data[].extend.sourceInfo | object | 一覧で明示的に scriptType=rumToMetric を指定した場合にのみ補完を試みます。詳細/書き込みでは自動提供されません。キーは extend.source の app_id です。 |
| content.data[].extend.sourceInfo.アプリケーションID | object | そのアプリケーションの情報です。一致しない場合やクエリ失敗時は空オブジェクトになることがあります。 |
| content.data[].extend.sourceInfo.アプリケーションID.status | integer | アプリケーションエンティティのステータスです。非アクティブな履歴レコードが含まれる場合があります。 |
| content.data[].extend.sourceInfo.アプリケーションID.jsonContent | object | RUM アプリケーションに保存された設定 JSON です。表示用であり、アプリケーションタイプによって変化します。このインターフェースの書き込み可能なパラメータとして扱わないでください。 |
| content.data[].extend.sourceInfo.アプリケーションID.jsonContent.設定キー | JSON | RUM アプリケーションタイプに応じて返される設定フィールドです。たとえば name/type などです。このインターフェースは統一されたアプリケーション構造を保証しません。 |
| content.declaration | object | ワークスペースの共通宣言。 |
| pageInfo.pageIndex | integer | 現在のページ番号。 |
| pageInfo.pageSize | integer | 1 ページあたりの件数。 |
| pageInfo.count | integer | このページの実際の件数。 |
| pageInfo.totalCount | integer | フィルター後の総件数。 |
{
"code": 200,
"content": {
"data": [
{
"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": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"creatorInfo": {},
"updatorInfo": {}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 100,
"count": 1,
"totalCount": 1
}
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した場合、またはパラメータがルールに違反した場合 | パラメータ解析失敗 | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | ルールの読み取りまたはレスポンスのフォーマットに失敗した場合 | 内部エラー | ワークスペースと UUID を確認し、失敗が続く場合は traceId を提供してください。 |
| 403 | ft.Forbidden | API Key の権限が不足しているか、ワークスペースのバージョンがこの機能をサポートしていない場合 | 操作権限がありません | 対応する権限を持つ API Key と、メトリクスを生成する機能をサポートするワークスペースを使用してください。 |