アップロード済みの分割パート一覧を取得¶
POST /api/v1/rum_sourcemap/part_list
概要¶
アップロードセッションに現在保存されているパート番号を読み取ります。
呼び出し前の準備と使用手順¶
現在の Key には rum.rumCfgManage が必要です。現在の Key が属するワークスペースに限ります。appId は RUM アプリケーション簡易一覧 の content[].appId から取得し、SDK/エラーレコードの app_id と一致している必要があります。データベース内部の UUID で代替することはできません。SourceMap はアプリケーション、環境 env、バージョン version によって正確に特定されます。大文字・小文字や空白は識別子自体の一部であり、収集レコードと完全に一致している必要があります。env/version を省略するか空文字列を指定した場合は、空の環境/空のバージョンを表し、すべてにワイルドカード一致するわけではありません。現在のマネージドライフサイクルでは、それぞれ最大 256 文字であることが求められます。
フローについては SourceMap 分割パートアップロード関連インターフェース使用説明 を参照してください。また、分割パートアップロード操作ドキュメント も参照できます。初期化→元の ZIP のすべての分割パートをアップロード→パート一覧を照合→マージ→バージョン状態とファイルツリーを照会、の順に実行します。初期化/マージの成功は、ZIP が検証済みまたは解析可能であることを意味しません。processing/failed/blocked などの状態は引き続き確認する必要があります。
POST の JSON で元の uploadId を渡すと、整数の番号を昇順に並べた配列を返します。パートがない場合は [] です。呼び出し元は、自身の分割パート一覧を使用して、数量、インデックス、および各パートの元の内容を照合してからマージする必要があります。本インターフェースは、パートサイズ、ダイジェスト、総パート数、アップロード進捗率を提供しません。
このエンドポイントはアップロードキャッシュとアプリケーションの帰属を検証しますが、読み取りのたびに「対象が依然として書き込み可能な状態にある」と解釈するものではありません。マージが既に開始されている場合でも、キャッシュ/一時パートが存在する可能性があります。返される番号は、未公開であること、マージが成功したこと、または ZIP が完全であることを証明するものではありません。読み取り専用キャッシュが期限切れ/タスクが上書き済みの場合は 406 を返し、ワークスペースをまたぐアプリケーションが読み取り不可の場合は NotFoundRumSet を返します。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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/part_list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"uploadId":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.uploadId | string | セッション ID。 |
| content.chunkIndexs | array<integer> |
保存済み番号の昇順リスト。フィールドの綴りは chunkIndexs です。 |
| content.chunkIndexs[] | integer | 保存済みの 1 つのパート番号。 |
| content.declaration | object | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"uploadId": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaabbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
"chunkIndexs": [
0,
1,
2
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては 共通エラー定義 を参照してください。
| 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 | セッションキャッシュが存在しない/期限切れ、または ID が後続のセッションによって置き換えられた | 無効な UploadId 値、またはタスクが上書きされています | 元の uploadId とアップロード済みパートを照合してください。古いセッションと公開状態を確認してから再初期化し、盲目的に上書きしないでください。 |
| 500 | ft.InternalServerError | データベース、ファイル読み取り/スナップショット、履歴設定、または未処理の解析例外 | 内部エラー | traceId とアプリケーション/env/version を保持し、まずバージョン状態とファイルを確認してから、実際のエラーに応じて処理してください。読み取りはバックオフして再試行できます。 |