分割アップロードイベントをキャンセルする¶
POST /api/v1/rum_sourcemap/upload_cancel
概要¶
まだマージ・公開フェーズに進んでいない SourceMap の分割アップロードセッションをキャンセルします。
呼び出し前の準備と使用手順¶
現在の Key には rum.rumCfgManage 権限が必要です。対象は現在の Key が属するワークスペースのみです。appId は RUM アプリケーション簡易一覧 の content[].appId を使用し、SDK/エラーレコードの app_id と一致させてください。データベース内部の UUID で代用することはできません。SourceMap はアプリケーション、環境 env、バージョン version で厳密に特定されます。大文字・小文字や空白も識別子そのものの一部であるため、収集レコードと完全に一致させる必要があります。env/version を省略するか空文字列を指定した場合は、空の環境/空のバージョンを意味し、すべてに一致するワイルドカードではありません。現在のマネージドライフサイクルでは、それぞれ最大 256 文字までです。
フローは SourceMap 分割アップロード関連インターフェース使用説明 を参照してください。あわせて 分割アップロード操作ドキュメント も参考にできます。初期化 → 元の ZIP の全パートをアップロード → パート一覧を確認 → マージ → バージョン状態とファイルツリーを照会、の順に実行します。初期化/マージの成功は、ZIP が検証済みであることや解析可能であることを意味しません。processing/failed/blocked などの状態は引き続き確認が必要です。
キャンセルの対象は、その uploadId が属するアップロード世代のみです。以前に公開された同一環境/バージョンを削除したり、公開済みファイルを取り消したりするものではありません。マージされていないセッションはアップロード失敗としてマークされ、一時パートのクリーンアップが予定されます。書き込み中のパートは自然に終了する必要があり、ディレクトリは後で回収される可能性があります。マージマーカーが生成済みの場合は 409 が返ることがあり、キャンセル API で公開を強制中止することはできません。
キャッシュが存在しない/期限切れ/現在のタスクに一致しない場合でも true を返すことがあり、ヒット数も返されません。true を根拠に実際のタスクがキャンセルされたと判断することはできません。古いキャンセルを繰り返しても、後から作成された新しいセッションのキャッシュは消去されません。キャンセル後はまずバージョン一覧とパート/ファイルの状態を確認してから、再初期化するかどうかを決めてください。レスポンスは、すべてのファイル/容量の解放が完了したことを保証するものではありません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
ボディリクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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/upload_cancel' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"uploadId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 固定値 true。このキャンセルリクエストが処理されたことのみを示し、実際に一致するセッションが存在しない場合もあります。 |
| 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": true,
"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 | キャッシュがまだ一致しているのに関連世代がすでにキャンセル不可/置換済み、または古いセッションとマネージドアプリケーションの状態が競合。キャッシュにまったく一致がない場合は true となり得る | 無効な 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 を保持し、まず一覧/ファイルツリーを確認してください。失敗時にはすでにファイルが公開されている、または処理マーカーが付いている可能性があるため、無闇に再度上書き/削除しないでください。 |