分割ファイルの結合生成¶
POST /api/v1/rum_sourcemap/part_merge
概要¶
アップロード済みの番号順に ZIP を結合し、非同期の解凍と公開をスケジュールします。
呼び出し前の準備と使用手順¶
現在の Key には rum.rumCfgManage が必要です。現在の Key が属するワークスペースのみが対象です。appId は RUM アプリ簡易一覧 の content[].appId から取得し、SDK/エラーレコードの app_id と一致させます。データベース内部の UUID で置き換えることはできません。SourceMap はアプリ、環境 env、バージョン version で正確に特定します。大文字小文字や空白は識別子そのものに含まれるため、収集レコードと完全に一致させる必要があります。env/version を省略するか空文字列にすると、空の環境/空のバージョンを表し、すべてにワイルドカード一致するわけではありません。現在のマネージドライフサイクルでは、それぞれ最大 256 文字であることが要求されます。
フローについては SourceMap 分割アップロード関連インターフェース使用説明 を参照し、分割アップロード操作ドキュメント も参考にしてください。初期化 → 元の ZIP の全スライスをアップロード → 分割リストを確認 → 結合 → バージョン状態とファイルツリーを照会、の順に実行します。初期化/結合の成功は、ZIP が検証済みまたは解析可能であることを意味しません。processing/failed/blocked などの状態は引き続き確認する必要があります。
chunkIndexs は互換性のための宣言であり、現在の結合コントローラーはこの配列を読み取りません。実際にはそのセッションディレクトリ内のすべての数字番号をスキャンし、整数で並べ替えて結合します。これを使用して一部のスライスを選択したり、順序を変更したり、総スライス数を宣言したりすることはできません。マネージドパスには少なくとも 1 つのスライスが必要で、番号は連続している必要がありますが、開始点は 0 である必要はありません。呼び出し元は、期待するすべてのスライスがアップロード済みであることを引き続き確認する必要があります。連続しているからといって、末尾のスライスが欠落していないことを証明するものではありません。
正常な新規セッションでは content.state=processing を返し、タスク ID や完了済みの進捗は返しません。旧互換セッションでは {} を返すことがあります。バックグラウンドで安全な解凍、容量、Web .map 内容の検証を実行した後にのみ新しい世代を公開します。失敗した場合は、公開済みの旧バージョンが保持され、failed/reasonCode が記録されることがあります。ZIP にはパストラバーサル/リンク/デバイスファイルを含めてはならず、デフォルトで展開されるファイル総量は最大 2 GiB です(サイトごとに変更可能)。Web には実際に有効な version=3 SourceMap が必要で、任意の JSON の名前を .map に変更するだけでは不十分です。
キューへの配信に失敗した場合、ディスクに書き込み済みの結合マーカーを保持し、定期的な復旧に委ねることがあり、インターフェースは成功を返す可能性があります。一時的に processing であるという理由だけで初期化を繰り返して上書きしないでください。結合マーカー後は、分割の書き込み/キャンセルが保護されます。バージョンリストとファイルツリーを読み取り、公開を確認し、実際に解析して受け入れてください。このリクエストは汎用的な冪等タスクではありません。結合を繰り返すと拒否されたり、重複してキューに入ったりする可能性があります。ネットワーク結果が不明な場合は、まず現在の状態を照会してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| chunkIndexs[*] | integer | 互換番号要素。整数を推奨します。このパラメータは実際のスキャン結合には使用されません。 例: 0取得または入力方法: アップロード済みの分割リストと同じです。 |
|
| chunkIndexs | array | オプションの配列ですが、現在の実装では無視され、結合範囲の制御やクライアント側の完全性チェックの代用にはなりません。省略を推奨します。 空文字列を許可: False null を許可: False 例: [0, 1, 2]取得または入力方法: part_list から保存済みの番号を取得できますが、現在この互換フィールドを送信する必要はありません。 |
|
| uploadId | string | Y | 必須のアップロードセッション ID。自身で連結したり、taskId で代替したりしないでください。同じワークスペースで管理権限を持つ Key は継続でき、作成した Key によって分離されません。セッションのデフォルトは 3600 秒で、分割アップロードでは自動更新されません。期限切れ/新しいセッションによる上書きの場合は、確認後に再初期化してください。 null を許可: False 例: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb取得または入力方法: 初期化分割アップロード の成功レスポンス content.uploadId をそのまま保存します。 |
パラメータ補足説明¶
フローについては SourceMap 分割アップロード関連インターフェース使用説明 を参照し、分割アップロード操作ドキュメント も参考にしてください。初期化 → 元の ZIP の全スライスをアップロード → 分割リストを確認 → 結合 → バージョン状態とファイルツリーを照会、の順に実行します。初期化/結合の成功は、ZIP が検証済みまたは解析可能であることを意味しません。processing/failed/blocked などの状態は引き続き確認する必要があります。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/rum_sourcemap/part_merge' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"uploadId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.state | string | 成功したマネージドレスポンスでは固定で processing となり、非同期処理がスケジュールされたことを示します。一部のエラー診断では state でその時点の世代状態を表すこともあります。 |
| 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.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": {
"state": "processing",
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
{
"code": 200,
"content": {},
"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 | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認します。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON 形式エラー | content.reason、line、column に従って JSON を修正します。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の json ファイル形式エラー | uploadId オブジェクトを送信します。 |
| 404 | ft.NotFoundRumSet | アプリが現在のワークスペースにない、削除済み、または存在しない | 指定された RUM 設定が見つかりません | RUM アプリ簡易一覧を更新し、現在のワークスペースの実際の appId を使用します。 |
| 406 | ft.InvalidUploadId | セッションキャッシュの失効/置換、対象世代の状態が結合を許可しない、または分割がない/数字インデックスが連続していない | 無効な UploadId 値、またはタスクが上書き済み | 元の uploadId とアップロード済み分割を確認します。旧セッションと公開状態を確認してから再初期化し、盲目的に上書きしないでください。 |
| 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 | データベース、Redis、ストレージの読み書き、キュー、または未処理のシステム例外 | 内部エラー | traceId、アプリ/env/version/uploadId を保持し、まずリスト/ファイルツリーを確認します。失敗していてもファイルが公開済みまたは処理マーカーが付いている可能性があるため、盲目的に再度上書き/削除しないでください。 |