コンテンツにスキップ

削除



GET /api/v1/viewer/{viewer_uuid}/delete

概要

既存の GET ルートを使用して、指定したエクスプローラーを削除します。

呼び出し前の確認と使用手順

エクスプローラー一覧から削除対象の UUID を確認します。復元が必要な場合は、事前にエクスプローラーのエクスポートでバックアップしてください。削除すると、エクスプローラーと関連するグラフ、変数などの内容がクリーンアップされます。この GET は状態を書き込むため、削除を確認した後にのみ明示的に呼び出してください。

ルートパラメータ

パラメータ名 型 必須 説明
viewer_uuid string Y 現在のワークスペースにある対象エクスプローラーの UUID。
例: dsbd_view_example
取得または入力方法: エクスプローラー一覧の content.data[].uuid から取得します。作成レスポンスの content.uuid から取得することもできます。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

パラメータ補足説明

リクエストがタイムアウトした場合や結果が不明な場合は、まずエクスプローラー一覧を確認してから次の操作を決定してください。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/viewer/dsbd_view_example/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要なフィールドを示しています。

フィールド 型 説明
content array<string> 削除されたエクスプローラー名の配列。
{
  "code": 200,
  "content": [
    "主机巡检查看器"
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
404 ft.NotFoundView 対象が存在しない、削除済み、または現在のワークスペースにない 指定されたビューが見つかりません 同じワークスペースのエクスプローラー一覧で有効な UUID を再確認してください。

フィードバック

このページは役に立ちましたか?