コンテンツにスキップ

エクスポート



GET /api/v1/dashboards/{dashboard_uuid}/export

概要

指定したダッシュボードを移植可能なテンプレートオブジェクトとしてエクスポートします。

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

読み取りに成功したら、レスポンスの content を保存します。これは作成またはインポート時の templateInfo として使用できます。ローカルで対象のダッシュボードを確認する必要がある場合は、まず一覧または詳細で UUID を検証してください。エクスポートでは元のワークスペースのデフォルトクエリ空間とサイト設定が削除されるため、移行後は移行先のワークスペースで再設定する必要があります。

ルートパラメータ

パラメータ名 タイプ 必須 説明
dashboard_uuid string Y 対象ダッシュボードの UUID。
例: dsbd_example
取得または入力方法: ダッシュボード一覧 の content.data[].uuid からコピーします。作成結果の content.uuid から取得することもできます。

リクエストヘッダー

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

Query リクエストパラメータ

パラメータ名 タイプ 必須 説明
title string オプション。エクスポートするテンプレートのタイトルのみを変更します。省略した場合は元のタイトルを保持します。
例: 生产巡检模板
取得または入力方法: 必要に応じて、エクスポートするテンプレートに保存するタイトルを入力します。

パラメータ補足説明

本インターフェースは JSON オブジェクトを返し、content をテンプレート本体としてやり取りします。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/dashboards/dsbd_example/export' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

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

フィールド タイプ 説明
content.title string テンプレート名。title Query パラメータを指定した場合はその値を使用します。
content.summary string テンプレートの説明。
content.identifier string ダッシュボードのカスタム識別子。
content.dashboardType string ダッシュボードのタイプ。
content.dashboardOwnerType string 元のダッシュボードの帰属タイプ。
content.dashboardExtend object 移植可能な拡張情報。デフォルトクエリ空間と対象サイトはインポート後に再設定する必要があります。
content.dashboardMapping array<object> フィールドマッピングのリスト。
content.dashboardBindSet array 関連付けバインディング設定。
content.iconSet object ダッシュボードのアイコン情報。
content.thumbnail string サムネイルフィールド。
content.tagInfo array<object> テンプレートに関連付けられたタグ。
content.main object テンプレート内のグラフ、変数、およびグラフグループ。
content.main.type string エクスポートテンプレートでは template に固定されます。
content.main.charts array<object> テンプレートのグラフ定義。
content.main.vars array<object> ビュー変数の定義。
content.main.groups array<object> グラフグループの定義。
content.main.groups[].name string グラフグループ名。
content.main.groups[].extend object グラフグループの拡張設定。
content.main.chartGroupPos array<string> グラフグループの並び順の記録。
content.declaration object または null ワークスペースの共通宣言。
{
  "code": 200,
  "content": {
    "title": "生产巡检",
    "summary": "生产服务巡检指标",
    "identifier": "prod-check",
    "dashboardType": "CUSTOM",
    "dashboardExtend": {},
    "dashboardMapping": [],
    "iconSet": {},
    "dashboardBindSet": [],
    "main": {
      "type": "template",
      "charts": [],
      "vars": [],
      "chartGroupPos": [],
      "groups": []
    },
    "dashboardOwnerType": "node",
    "thumbnail": "",
    "tagInfo": [],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。

現在のワークスペース内にアクティブなダッシュボードが見つからない場合は、HTTP 200 と空のオブジェクトが返されることがあります。空でない title を同時に指定した場合、結果にはエクスポートタイトルと共通レスポンスフィールドのみが含まれることがあります。テンプレートを使用する前に main が含まれているか確認してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.InvalidParameter 過去のグラフクエリ構造が無効で、有効なテンプレートとしてエクスポートできない パラメータ{}が無効 エラー内のフィールドパスに従って元のビューのグラフ設定を確認し、修正してから再エクスポートしてください。

フィードバック

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