一覧取得¶
GET /api/v1/error_track_rule/list
概要¶
エラー追跡ルールをページングで一覧取得します。
呼び出し前の準備と使用手順¶
現在の Key には errorCenter.errorTrackRuleQuery が必要です。対象は現在のワークスペースの未削除ルールのみで、無効状態 2 を含みます。id の降順でページングし、名前の search と type を組み合わせて指定できます。リストの data 項目には creatorInfo/updatorInfo が付加されます。
rum ソースのみ sourcesInfo が付加され、* は {name:*} のサマリーを返し、不明な appId は {} を返します。サマリー検索には削除済みの RUM アプリケーションが含まれる可能性があるため、まずアクティブなアプリケーションの簡易一覧で実際の接続を確認してください。その他のタイプには sourcesInfo はありません。ルールは Studio に保存済みの設定を表すのみであり、エラーレコードが生成済みであること、履歴の遡及再計算が完了していること、下流で即時反映されていることを意味するものではありません。content.declaration は親の共通宣言であり、リストの pageInfo はトップレベルにあり、data は content.data に保持されます。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得してください。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| pageIndex | integer | 省略可能な正の整数。省略時は 1、最小値は 1。 null 許可: False $minValue: 1 例: 1取得または入力方法: 呼び出し元によるページング制御。 |
|
| pageSize | integer | 省略可能な整数 1~100。省略時は 20。旧サンプルの 10 はデフォルト値ではありません。 null 許可: False $maxValue: 100 $minValue: 1 例: 20取得または入力方法: 呼び出し元によるページング制御。 |
|
| search | string | 省略可能な名前のあいまい一致。先頭と末尾の空白は除去され、省略または空白の場合はフィルタしません。SQL LIKE のセマンティクスで、% と _ はワイルドカードとして意味を持ち、リテラルな部分文字列のエスケープは保証しません。 null 許可: True 例: 支付取得または入力方法: 呼び出し元がルール名で検索します。 |
|
| type | string | 省略可能な logging/tracing/rum。省略時はフィルタしません。空文字列は公開列挙に含まれません。 null 許可: False 選択可能値: ['logging', 'tracing', 'rum'] 例: rum取得または入力方法: ルールのソースタイプでフィルタします。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/error_track_rule/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20 \
--data-urlencode type=rum
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | ルールのページングコンテンツオブジェクト。 |
| content.data | array<object> |
このページの有効/無効ルール。一致しない場合は []。 |
| content.data[].id | integer または null | データベースの行 ID。パス特定には使用しません。送信前のスナップショットでは null の可能性があります。 |
| content.data[].uuid | string | エラー追跡ルールの UUID。issetrule_ プレフィックスが付きます。エラー処理メタデータの isset_ やテレメトリの issue_id ではありません。 |
| content.data[].status | integer | データベースの状態: 0 有効、2 無効、3 論理削除(読み取り時は 3 を除外)。 |
| content.data[].creator | string | 作成主体の UUID。この公開エントリでは通常、Key リソース作成時の wsak_ です。履歴レコードでは他の主体の場合があり、sys メタデータを自動初期化しません。 |
| content.data[].updator | string | 最終更新主体。未更新の場合は空になることがあります。 |
| content.data[].createAt | integer | Unix 秒の作成時刻。 |
| content.data[].updateAt | integer | Unix 秒の更新時刻。作成後に未更新の場合は通常 -1。 |
| content.data[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。 |
| content.data[].workspaceUUID | string | 現在の Key が属するワークスペース。 |
| content.data[].name | string | ルール名。同名も可能です。 |
| content.data[].desc | string | ルールの説明。 |
| content.data[].type | string | logging/tracing/rum。 |
| content.data[].sources | array | 保存済みのソース配列。クライアントは文字列のみを使用してください。履歴の非文字列値は許容する必要があります。 |
| content.data[].sources[] | JSON | 通常はインデックス名/appId/サービス名または *。ロールやアカウント ID ではありません。 |
| content.data[].extend | object または null | 保存された拡張。通常はオブジェクトとして書き込まれます。履歴値は許容する必要があります。 |
| content.data[].extend.カスタムキー | JSON | カスタム保存値。固定の実行セマンティクスはありません。 |
| content.data[].sourcesInfo | array<object> |
rum ルールの list/get にのみ付加され、sources と同じ順序です。解析できない項目は {} で、アプリケーションが引き続きアクティブであることは保証されません。 |
| content.data[].sourcesInfo[].appId | string | 実際のアプリケーションの appId。ワイルドカード項目は *。 |
| content.data[].sourcesInfo[].jsonContent | object | 元の RUM アプリケーションの jsonContent。クエリは削除済みアプリケーションを除外しないため、サマリーから引き続きアクティブであると判断することはできません。 |
| content.data[].sourcesInfo[].jsonContent.name | string | アプリケーションの表示名。ワイルドカード項目は *。 |
| content.data[].sourcesInfo[].jsonContent.type | string | アプリケーションのプラットフォーム。ワイルドカード項目には通常ありません。 |
| content.data[].sourcesInfo[].jsonContent.extend | object | 省略可能なアプリケーションの動的拡張。 |
| content.data[].sourcesInfo[].jsonContent.extend.カスタムキー | JSON | アプリケーションの保存済み拡張値。 |
| content.data[].creatorInfo | object | リストにのみ付加される主体のサマリー。一致しない場合は {}。システム主体ではフィールドがアカウントより少ない場合があります。 |
| content.data[].creatorInfo.uuid | string | 主体の UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.data[].creatorInfo.status | integer | 主体の状態。 |
| content.data[].creatorInfo.wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係の状態サマリー。 |
| content.data[].creatorInfo.username | string | ログイン名または Key 名。 |
| content.data[].creatorInfo.name | string | 表示名。 |
| content.data[].creatorInfo.iconUrl | string | アバター URL。空の場合があります。 |
| content.data[].creatorInfo.email | string | メールアドレス。Key 主体では自身の UUID の場合があり、配信可能であることは保証されません。 |
| content.data[].creatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].creatorInfo.countryCode | string | 電話の国番号。空の場合があります。 |
| content.data[].creatorInfo.acntWsNickname | string | 現在のワークスペースのニックネーム。空の場合があります。 |
| content.data[].updatorInfo | object | リストにのみ付加される主体のサマリー。一致しない場合は {}。システム主体ではフィールドがアカウントより少ない場合があります。 |
| content.data[].updatorInfo.uuid | string | 主体の UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.data[].updatorInfo.status | integer | 主体の状態。 |
| content.data[].updatorInfo.wsAccountStatus | integer | 現在のワークスペースにおけるメンバー関係の状態サマリー。 |
| content.data[].updatorInfo.username | string | ログイン名または Key 名。 |
| content.data[].updatorInfo.name | string | 表示名。 |
| content.data[].updatorInfo.iconUrl | string | アバター URL。空の場合があります。 |
| content.data[].updatorInfo.email | string | メールアドレス。Key 主体では自身の UUID の場合があり、配信可能であることは保証されません。 |
| content.data[].updatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.data[].updatorInfo.countryCode | string | 電話の国番号。空の場合があります。 |
| content.data[].updatorInfo.acntWsNickname | string | 現在のワークスペースのニックネーム。空の場合があります。 |
| pageInfo | object | ページングのメタ情報。OpenAPI ではトップレベルにあります。content はオブジェクトのままです。 |
| pageInfo.count | integer | このページの実際の件数。 |
| pageInfo.totalCount | integer | フィルタ条件を満たす候補/ローカルレコードの総数。テレメトリリストは候補上限 10000 の制約を受けます。 |
| pageInfo.pageIndex | integer | ページ番号。1 から始まります。 |
| pageInfo.pageSize | integer | 今回の 1 ページあたりのリクエスト件数。 |
| content.declaration | object または null | 現在のワークスペースの共通宣言。content の親オブジェクトにのみ追加され、data 項目に再帰的に追加されることはありません。 |
{
"code": 200,
"content": {
"data": [
{
"id": 7,
"uuid": "issetrule_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"name": "決済Webエラー集約",
"desc": "決済Webアプリケーションのエラーを追跡",
"type": "rum",
"sources": [
"payment_web"
],
"extend": {
"ownerTeam": "payment"
},
"sourcesInfo": [
{
"appId": "payment_web",
"jsonContent": {
"name": "決済Web",
"type": "web"
}
}
],
"creatorInfo": {},
"updatorInfo": {}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"count": 1,
"totalCount": 1,
"pageIndex": 1,
"pageSize": 20
}
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反した | パラメータの解析に失敗しました | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | データベース読み取り、履歴 JSON 構造、または関連サマリーの構築で未処理の例外が発生した | 内部エラー | traceId を保持してバックオフしてください。失敗が続く場合は、管理者に関連する履歴レコードと設定の確認を依頼してください。 |