詳細¶
GET /api/v1/error_track/{issue_id}/get
概要¶
エラー処理メタデータを読み取り、初回アクセス時に初期化します。
呼び出し前の前提と使用手順¶
現在の Key には errorCenter.errorTrackQuery が必要です。パスには一覧の issue_id を使用する必要があります。返されるのはローカル処理メタデータであり、元の error_stack などのテレメトリレコードは含まれません。
ローカルメタデータが見つからない場合は、直近 30 日間の EH をクエリし、Triage と空の担当者で初期化してからコミットします。テレメトリに一致するものがない場合や、このクエリが失敗した場合でも、デフォルトオブジェクトが作成される可能性があります。firstTime は現在のミリ秒を返し、errorType は空になります。このエントリポイントで実際のエラーの存在を確認することはできません。また、初期化時刻を全履歴における初回として扱うこともできません。
GET ですが、初回の読み取りではローカルメタデータが書き込まれます。重複/同時リクエストには、このページで公開されている冪等キーはありません。duration はサイクル単位で計算される互換性のための秒数で、Resolved/Ignored であっても増加する可能性があります。statusDuration はステータス進入時刻(Unix 秒)のマッピングです。
パスパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| issue_id | string | Y | エラー集約の業務識別子。そのまま渡します。refData.uuid(isset_)やコメント UUID ではありません。パスは URL エンコードで処理されます。詳細インターフェースでテレメトリの存在を検証しないでください。 例: err_payment_timeout取得または入力方法: エラー追跡リスト から content.data[].issue_id を取得するか、現在のワークスペースのエラーセンターにあるテレメトリレコードの issue_id を使用します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得してください。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/error_track/err_payment_timeout/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例では、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | ローカルメタデータと計算/アイデンティティの概要。 |
| content.id | integer または null | データベースの行 ID。パスの特定には使用しません。コミット前のスナップショットでは null の可能性があります。 |
| content.uuid | string | ローカルリソースの UUID。詳細メタデータは isset_、操作レコードは issetoper_、コメントは issetcomment_ です。 |
| content.status | integer | リソースステータス。通常は 0 で、ソフト削除の 3 はクエリから除外されます。 |
| content.creator | string | 作成主体。自動初期化メタデータは sys、Key による書き込み主体は wsak_ です。 |
| content.updator | string | 最終更新主体。未更新の場合は空になることがあります。 |
| content.createAt | integer | Unix 秒の作成時刻。 |
| content.updateAt | integer | Unix 秒の更新時刻。未更新の場合は -1 になることがあります。同じ値でのステータス/担当者の更新では、必ずしも更新されません。 |
| content.deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1 です。 |
| content.workspaceUUID | string | 現在の Key が属するワークスペース。 |
| content.issueID | string | テレメトリの issue_id の業務識別子。ローカルの uuid とは異なります。 |
| content.assigner | array<string> |
担当者のアカウント acnt_ またはチーム group_。現在の保存順で、空配列は未割り当てです。 |
| content.assigner[] | string | 個々の担当者識別子。保存に成功しただけで、アカウントの存在や通知可能性を判断することはできません。 |
| content.issueStatus | string | Triage/Assigned/Working/Resolved/Ignored。 |
| content.extend | object または null | ローカルメタデータの拡張。過去の異常値は許容する必要があります。 |
| content.extend.errorType | string | 初期化時にクエリされたエラータイプ。クエリ失敗/データなしの場合は空になる可能性があります。 |
| content.extend.firstTime | integer | 初期化時に直近 30 日間の create_time(Unix ミリ秒)をクエリした結果。クエリ失敗/データなしの場合は現在のミリ秒を返し、全履歴における初回であることは保証されません。 |
| content.extend.statusChangeRecords | array<object> |
ステータス変更レコード。各項目は保存履歴の順序に従います。 |
| content.extend.statusChangeRecords[].status | string | 上記ステータスのいずれか。 |
| content.extend.statusChangeRecords[].time | integer | ステータス進入時刻(Unix 秒)。 |
| content.extend.statusChangeRecords[].operator | string | 操作主体の UUID/システム識別子。 |
| content.extend.その他のキー | JSON | 過去に保存されたその他の拡張キー。固定の実行パラメータではありません。 |
| content.duration | integer | 秒。過去の完全なサイクルの時間差の合計に「現在時刻 - 最後の Triage サイクル開始時刻」を加えた値。Resolved/Ignored でも引き続き増加する可能性があり、厳密な MTTR ではありません。計算異常時は欠落する可能性があります。 |
| content.statusDuration | object | 直近の Triage サイクルにおけるステータス進入時刻のマッピング。各ステータスの継続秒数ではありません。計算異常時は省略される可能性があります。 |
| content.statusDuration.ステータス | integer | Triage/Assigned/Working/Resolved/Ignored のうち実際に出現し、増加順の選択条件を満たす Unix 秒時刻。 |
| content.creatorInfo | object | 作成主体の概要。一致しない場合は {}。システム主体のフィールドはアカウントより少ない場合があります。 |
| content.updatorInfo | object | 更新主体の概要。一致しない場合は {}。 |
| content.assignerInfo | array<object> |
解析可能な担当者の概要。無効なアカウントは含まれない場合があり、assigner と同じ長さになることは保証されません。 |
| content.assignerInfo[].uuid | string | アカウントまたはチームの UUID。 |
| content.assignerInfo[].name | string | 表示名。チーム概要には uuid/name のみが含まれます。 |
| content.creatorInfo.uuid | string | 主体の UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.creatorInfo.status | integer | 主体ステータス。 |
| content.creatorInfo.wsAccountStatus | integer | 現在のワークスペースにおけるメンバーシップステータスの概要。 |
| content.creatorInfo.username | string | ログイン名または Key 名。 |
| content.creatorInfo.name | string | 表示名。 |
| content.creatorInfo.iconUrl | string | アバター URL。空の場合があります。 |
| content.creatorInfo.email | string | メールアドレス。Key 主体の場合は自身の UUID となることがあり、配信可能であることは保証されません。 |
| content.creatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.creatorInfo.countryCode | string | 電話の国番号。空の場合があります。 |
| content.creatorInfo.acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| content.updatorInfo.uuid | string | 主体の UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.updatorInfo.status | integer | 主体ステータス。 |
| content.updatorInfo.wsAccountStatus | integer | 現在のワークスペースにおけるメンバーシップステータスの概要。 |
| content.updatorInfo.username | string | ログイン名または Key 名。 |
| content.updatorInfo.name | string | 表示名。 |
| content.updatorInfo.iconUrl | string | アバター URL。空の場合があります。 |
| content.updatorInfo.email | string | メールアドレス。Key 主体の場合は自身の UUID となることがあり、配信可能であることは保証されません。 |
| content.updatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.updatorInfo.countryCode | string | 電話の国番号。空の場合があります。 |
| content.updatorInfo.acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| content.assignerInfo[].status | integer | 主体ステータス。アカウント概要のみで、チームにはこのキーは含まれません。 |
| content.assignerInfo[].wsAccountStatus | integer | 現在のワークスペースにおけるメンバーシップステータスの概要。アカウント概要のみで、チームにはこのキーは含まれません。 |
| content.assignerInfo[].username | string | ログイン名または Key 名。アカウント概要のみで、チームにはこのキーは含まれません。 |
| content.assignerInfo[].iconUrl | string | アバター URL。空の場合があります。アカウント概要のみで、チームにはこのキーは含まれません。 |
| content.assignerInfo[].email | string | メールアドレス。Key 主体の場合は自身の UUID となることがあり、配信可能であることは保証されません。アカウント概要のみで、チームにはこのキーは含まれません。 |
| content.assignerInfo[].mobile | string | 携帯電話番号。空の場合があります。アカウント概要のみで、チームにはこのキーは含まれません。 |
| content.assignerInfo[].countryCode | string | 電話の国番号。空の場合があります。アカウント概要のみで、チームにはこのキーは含まれません。 |
| content.assignerInfo[].acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。アカウント概要のみで、チームにはこのキーは含まれません。 |
| content.declaration | object または null | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"id": 7,
"uuid": "isset_example",
"status": 0,
"creator": "sys",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"issueID": "err_payment_timeout",
"assigner": [],
"issueStatus": "Triage",
"extend": {
"errorType": "js_error",
"firstTime": 1785427200000,
"statusChangeRecords": [
{
"status": "Triage",
"time": 1785427200,
"operator": "wsak_example"
}
]
},
"duration": 60,
"statusDuration": {
"Triage": 1785427200
},
"creatorInfo": {
"uuid": "",
"name": "SYS",
"username": "SYS",
"email": "SYS",
"status": 0,
"wsAccountStatus": 0,
"mobile": ""
},
"updatorInfo": {},
"assignerInfo": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。
共通認証/宣言検証以外では、自動初期化時の EH クエリ例外はデフォルトメタデータとして許容されます。200 だけでテレメトリの存在を判断することはできません。読み取りによる初期化はコミットを伴うため、500 後はまず読み戻して確認してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | データベース読み取り、初回メタデータ初期化の書き込み/コミット、履歴 JSON または関連要約の構築で未処理の例外が発生 | 内部エラー | 初回 GET でメタデータがすでに作成されている可能性があります。まず詳細を読み戻して確認し、その後バックオフして再試行してください。traceId を保持したうえで、管理者にレコードの確認を依頼してください。 |