削除¶
POST /api/v1/snapshots/{snapshot_uuid}/delete
概要¶
指定したページスナップショットを論理削除します。
呼び出し前および使用手順¶
現在の Key には snapshot.delete が必要です。UUID は、現在の Key で参照可能なスナップショット一覧から取得し、管理権限を確認してください。現在の削除処理は内部で UUID により対象を特定しますが、ワークスペース/作成者によるフィルターが確実に付与されていません。呼び出し元は、自分が権限を付与され、現在のワークスペースに属することを確認済みの対象のみを送信する必要があります。誤って選択した UUID をサービス側が拒否することを前提にしてはいけません。未知または削除済みの場合も true を返し、ヒット件数はありません。
この公開エンドポイントでは deleteShareCfg を渡さず、共有設定の取消、初回リダイレクトコードの失効、共有キャッシュのクリアを同時に行いません。スナップショットを論理削除すると、関連リソースの読み取りは無効になりますが、共有設定は引き続き存在する可能性があります。共有を停止する必要がある場合は、まずコンソールの共有管理から share_ UUID を取得して個別に取り消してください。snap_ を共有の取消に渡すことはできません。ソーステレメトリ、元のダッシュボード、アプリケーションは削除されません。公開された復元インターフェースはないため、事前に設定を保存してください。
ルートパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| snapshot_uuid | string | Y | 共有設定の share_ UUID、token/authCode の初回リダイレクトコード、またはダッシュボード UUID ではありません。 例: snap_example取得または入力方法: スナップショット一覧 から content.data[].uuid を取得し、現在の Key で管理権限が確認できる snap_ UUID のみを操作します。 |
リクエストヘッダー¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報です。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメーターの補足説明¶
スナップショットはページ設定とサーバー側のクエリ範囲を保存します。インターネット共有には別途共有設定を作成する必要があり、snap_、share_、初回リダイレクトコード、2 段階 token はそれぞれ異なる識別子です。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/snapshots/snap_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例では、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 成功時は true(ヒットなしの場合を含む)。declaration/ヒット件数は含まれません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義 を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答の説明 | 対処方法 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | スナップショットの論理削除またはトランザクションコミット時に未処理の例外が発生 | 内部エラー | まずスナップショット一覧を確認し、削除済みかどうかを照合してください。失敗を「未反映」とみなさず、traceId を保持してください。関連する共有は個別に確認/取り消す必要があります。 |