コンテンツにスキップ

削除



GET /api/v1/dashboard/{dashboard_uuid}/delete

概要

指定した組み込みビューと関連設定を削除します。

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

組み込みビュー一覧から UUID を特定します。復元が必要な場合は、先に組み込みビューをエクスポートし、組み込みビューの詳細でバインド条件を保存してください。この GET リクエストは、ビューおよび関連するグラフ、変数、グループ、バインドを削除し、そのビューを参照するレポートにも影響する可能性があります。対象を確認したうえで、自らリクエストを送信してください。

ルートパラメータ

パラメータ名 型 必須 説明
dashboard_uuid string Y 現在のワークスペースの組み込みビュー UUID。
例: dsbd_inner_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/dashboard/dsbd_inner_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 を取得してください。
403 ft.ForbiddenOperationResource API Key に対象ビューへの有効な操作権限がない 操作権限がありません ワークスペースの所属と API Key の権限を確認するか、リソースの作成者に連絡してください。
403 ft.ForbiddenAccessResourceNoPublic プライベートビューにアクセスする ID が、ビューの作成者 ID と異なる リソースへのアクセス権限がありません。現在のページは非公開です アクセス権限を持つ作成者 ID で操作し、同じワークスペースの API Key を使用していることを確認してください。

フィードバック

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