一覧¶
GET /api/v1/rum_sourcemap/list
概要¶
RUM アプリケーションの各環境およびバージョンの SourceMap 状態サマリーを一覧表示します。
呼び出し前の準備と使用手順¶
Key は routine.defaultAccess、rum.rumCfgManage、anonymous.shared、anonymous.snapshotShared のいずれかに一致する必要がありますが、認証は引き続き実際の OpenAPI Key に従います。現在の Key が属するワークスペースのみが対象です。appId は RUM アプリケーション簡易一覧 の content[].appId から取得し、SDK/エラーレコードの app_id と一致させます。データベース内部の UUID で代替することはできません。SourceMap はアプリケーション、環境 env、バージョン version で正確に特定します。大文字小文字や空白は識別子そのものに属するため、収集レコードと完全に一致させる必要があります。env/version を省略するか空文字列を指定した場合は、空の環境/空のバージョンを意味し、すべてにワイルドカード一致するわけではありません。現在のマネージドライフサイクルでは、それぞれ最大 256 文字である必要があります。
OpenAPI は Query パラメータとして appId のみを公開し、フロントエンドの pageSize/pageIndex/search/env は受け付けません。アプリケーション全体の表示可能なすべての環境/バージョンの配列を返し、ページネーションは行わず、capabilities オブジェクトもありません。初回読み取り時には履歴ディレクトリと公開インデックスを安全に引き継ぐ場合があり、古いアップロード/インデックス更新との競合が発生した場合は 409 の通知に従って処理します。
最後に成功したアップロード時刻の降順で並びます。processing の新しい世代はリスト内の旧バージョンの表示を上書きする場合があり、failed への置き換えは既存の正常な現在の世代を隠しません。そのため、リストに failed が存在しないことは、直近の置き換えリクエストが成功したことを証明するものではありません。state=ready/settling は一般に読み取り可能、processing はまだアップロード/解凍/公開中、failed は失敗、blocked は reasonCode と合わせて履歴ディレクトリまたは復旧状況を確認する必要があります。削除中/削除済みの世代は一覧に表示されません。
createAt は最後に成功したアップロード時刻であり、タスクの作成時刻ではありません。まだ成功していない場合は 0 になることがあり、lastSuccessfulUploadAt は null になることがあります。サマリーのみを返し、uploadId、ファイル内容、解析結果は含まれません。アップロード完了後は ファイルツリー も確認し、実際のエラースタックで受け入れ検証を行ってください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| appId | string | Y | 現在のワークスペースで有効なアプリケーション識別子が必須です。内部の RumCfg UUID ではなく、ワークスペースを跨いで使用することはできません。 null 許可: False 例: payment_web取得または入力方法: RUM アプリケーション簡易一覧 の content[].appId またはエラーレコードの app_id から取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/rum_sourcemap/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode appId=payment_web
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | array<object> |
アプリケーションの表示可能なすべての環境/バージョンのサマリー。レコードがない場合は []、ページネーションなし。 |
| content[].env | string | 正確な環境識別子。空文字列も独立した環境です。 |
| content[].version | string | 正確なバージョン識別子。 |
| content[].createAt | integer | 最後に成功したアップロードの Unix 秒。成功していない場合は 0 になることがあり、旧レコードでは過去のアップロード時刻に基づきます。 |
| content[].lastSuccessfulUploadAt | integer または null | 最後に成功したアップロードの Unix 秒。まだ成功していない場合は null。旧互換レコードでは欠落する場合があります。 |
| content[].state | string | processing/ready/settling/failed/blocked など。旧互換レコードでは欠落する場合があります。 |
| content[].reasonCode | string または null | 直近の失敗/隔離理由(sourcemap_invalid/archive_too_large/legacy_invalid など)。正常時は null になることがあり、タスクごとの独立した結果ではありません。 |
| content[].declaration | object | 空でない各サマリーに共通宣言が挿入されます。 |
| content.reasonCode | string | エラーレスポンスのみ: 機械判読可能な理由。例: active_operation/invalid_scope/registry_missing。 |
| content.action | string | エラーレスポンスのみ: 推奨アクション。例: retry_after_operation/verify_ownership/check_scope_and_upload。 |
| content.retryable | boolean | エラーレスポンスのみ: サーバーが推奨する再試行可能フラグ。これのみを根拠に公開済みの書き込みを再実行することはできません。 |
| content.uploadCommitted | boolean | 一部の単一ファイルエラー診断のみ: true は該当する書き込みが公開済みであることを示します。省略は false や書き込み未確認を意味しません。 |
| content.actualBytes | integer | 一部の容量エラーのみ: 集計済みのバイト数。 |
| content.maxBytes | integer | 容量/読み取り制限のバイト数。 |
| content.workspaceUUID | string | 一部のエラーに限定した診断: 現在のワークスペース UUID。 |
| content.appId | string | 一部のエラーに限定した診断: 公開アプリケーション識別子。 |
| content.rumCfgUUID | string | 一部のエラーに限定した診断: 内部アプリケーション識別子。サポート調査にのみ使用し、リクエストの appId を置き換えるものではありません。 |
| content.env | string | 一部のエラー診断: 環境。 |
| content.version | string | 一部のエラー診断: バージョン。 |
| content.bundleUUID | string | 一部のエラー診断: 今回の世代レコード ID。uploadId ではありません。 |
| content.state | string | 一部のエラー診断: 世代の状態。 |
| content.resource | string | 一部の占有診断: リソース種別。例: application/bundle。 |
| content.shared | boolean | 一部の占有診断: 共有アクセスかどうか。 |
| content.waitedSeconds | number | 一部の占有診断: 待機済み秒数。 |
| content.waitSeconds | number | 一部の占有診断: 待機可能秒数。 |
| content.waitExhausted | boolean | 一部の占有診断: 今回の待機が枯渇したか。 |
| content.elapsedSeconds | number | 一部の単一ファイルエラー診断: 操作の所要秒数。 |
| content.phase | string | 一部のエラー診断: 失敗フェーズ。 |
| content.phaseElapsedSeconds | number | 一部のエラー診断: フェーズの所要秒数。 |
{
"code": 200,
"content": [
{
"env": "production",
"version": "1.2.3",
"createAt": 1785427200,
"lastSuccessfulUploadAt": 1785427200,
"state": "settling",
"reasonCode": null,
"declaration": {}
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
ストレージライフサイクルは互換性のためのエラーコードを保持します。409 は通常引き続き ft.InvalidAction であり、ローカライズされた message と content.reasonCode によって原因をさらに区別します。message 名 SourceMapOperationBusy などを必ず errorCode と見なすことはありません。読み取り時のパッケージ欠落/処理中/利用不可は通常 404 ft.SourceMapPackageNotFound であり、具体的な原因は reasonCode を確認してください。明確に retryable=true が返され、かつ現在の状態で許可されている場合にのみバックオフして再試行してください。uploadCommitted=true の場合は、公開が確認された書き込みを再実行することはできません。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータが規則に違反している | パラメータの解析に失敗しました | Query パラメータ表と例を確認してください。 |
| 404 | ft.NotFoundRumSet | アプリケーションが現在のワークスペースにない、削除済み、または存在しない | 指定された RUM 設定が見つかりません | RUM アプリケーション簡易一覧を更新し、現在のワークスペースの実際の appId を使用してください。 |
| 409 | ft.InvalidAction | アップロード/読み取り/クリーンアップの競合、旧ディレクトリの引き継ぎ未完了、帰属/復旧の検証待ち、または環境/バージョンがライフサイクルの許容範囲を超えている | reasonCode に応じて具体的なローカライズメッセージを返します。例: SourceMap が他のアップロード、読み取り、またはクリーンアップ操作で使用されています | content.reasonCode/action/retryable を確認します。active_operation/active_upload などは案内に従ってバックオフします。owner_recovery_required/ownership_verification_required/legacy_invalid などはまず管理者に検証を依頼し、占有レコードを自己判断で削除したり強制的に上書きしたりしないでください。invalid_scope の場合は env/version が最大 256 文字であることを確認してください。 |
| 406 | ft.InvalidFileName | ファイルの相対パス、シンボリックリンク、または過去の公開パスが安全でない | SourceMap ファイルのパスが要件を満たしていないか、サポートされていないリンクが含まれています。アップロードファイルの相対パスとディレクトリ構造を確認してください。 | パッケージ内の正当な相対パスを使用し、..、バックスラッシュ、絶対パス/シンボリックリンクを含めないでください。reasonCode=invalid_path を確認してください。 |
| 500 | ft.InternalServerError | データベース、ファイル読み取り/スナップショット、履歴設定、または未処理の解析例外 | 内部エラー | traceId とアプリケーション/env/version を保持し、まずバージョンの状態とファイルを確認してから、実際のエラーに応じて対処してください。読み取りはバックオフして再試行できます。 |