削除¶
POST /api/v1/rum_sourcemap/delete
概要¶
指定したアプリケーション、環境、バージョンのSourceMapファイルを手動で削除します。
呼び出し前の確認と使用手順¶
現在のキーにはrum.rumCfgManageが必要です。現在のキーが属するワークスペースのみが対象です。appIdはRUMアプリケーション簡易一覧のcontent[].appIdから取得し、SDK/エラーレコードのapp_idと一致している必要があります。データベース内部のUUIDで代用することはできません。SourceMapはアプリケーション、環境env、バージョンversionによって厳密に特定されます。大文字小文字/空白は識別子自体の一部であるため、収集レコードと完全に一致させる必要があります。env/versionを省略するか空文字列を指定した場合は、空の環境/空のバージョンを表し、すべてに一致するワイルドカードではありません。現在のマネージドライフサイクルでは、それぞれ最大256文字であることが要求されます。
復元できないファイル削除操作です。事前にバージョンが停止済みであること、およびビルド元の成果物を保持していることを確認してください。削除対象は指定したenv/versionのみで、アプリケーション全体/すべての環境の削除ではありません。また、RUMアプリケーション/クライアントTokenや履歴エラーレコードも削除しません。以前のエラーレコードは、ソースコードを再び復元できなくなる可能性があります。
現在の対象が存在せず、同じバージョンの未完了アップロードもない場合は、trueを返し、削除監査も記録されないことがあります。アップロード待ち、読み取り、クリーンアップの競合がある場合は409となり、占有状態を回避することはできません。正常時はまずクリーンアップをマークして所有権を取得し、その後でファイル削除/インデックス更新/レコード完了を行います。失敗時は、ファイルが削除済みでもインデックス/状態が収束せず、補償処理に入る可能性があります。一覧では削除中のレコードが非表示になりますが、一覧から消えたことだけでは物理的な回収が完了したことを証明できません。
HTTP 200/content=trueは本リクエストの完了を示し、削除したファイル数は提供されません。ネットワーク障害/500の場合は、まず一覧、ファイルツリーのエラー、traceIdを照合して確認し、盲目的に再削除したり、同じバージョンを再構築したりしないでください。手動削除は最新部数を保持する保護の対象外です。元のビルドファイルはお客様自身で保持してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースのOpenAPI認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースのAPI Key管理から、この操作権限を持つOpenAPI Keyを取得します。 |
Bodyリクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| appId | string | Y | 現在のワークスペースでアクティブなアプリケーション識別子が必須です。内部RumCfg UUIDではなく、ワークスペースをまたいで使用できません。 null許可: False 例: payment_web取得または入力方法: RUMアプリケーション簡易一覧のcontent[].appIdまたはエラーレコードのapp_idから取得します。 |
| env | string | 任意の文字列。デフォルトは空の環境で、最大256文字です。すべての環境を表すものではなく、nullは許可されません。 空文字列許可: True null許可: False 例: production取得または入力方法: クライアントのリリース環境/エラーレコードのenvから取得し、アップロード時と一字一句一致させます。 |
|
| version | string | 任意の文字列。デフォルトは空のバージョンで、最大256文字です。最新/すべてのバージョンを表すものではなく、nullは許可されません。 空文字列許可: True null許可: False 例: 1.2.3取得または入力方法: クライアントで実際にリリースされたバージョン/エラーレコードのversionから取得し、ビルド成果物に対応させます。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/rum_sourcemap/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"appId":"payment_web","env":"production","version":"1.2.3"}'
応答¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 固定でtrue。対象に一致がなくても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ファイル形式エラー | オブジェクトを送信してください。 |
| 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 | データベース、Redis、ストレージの読み書き、キュー、または未処理のシステム例外 | 内部エラー | traceId、アプリ/env/version/uploadIdを保持し、まず一覧/ファイルツリーを照合してください。失敗時は既にファイルが公開されているか処理マークが付いている可能性があるため、盲目的に再度上書き/削除しないでください。 |