コンテンツにスキップ

エクスポート



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

概要

指定した組み込みビューを JSON テンプレートとしてエクスポートします。

呼び出し前と使用手順

組み込みビュー一覧から有効な組み込みビューを選択します。レスポンスの content を保存し、作成時にそれを templateInfos に渡すことができます。エクスポートではデフォルトのクエリ空間および対象サイト情報が削除されるため、移行後に再設定してください。エクスポートテンプレートには dashboardBidding が含まれないため、組み込みビュー詳細から別途バインドを保存してください。

ルートパラメータ

パラメータ名 型 必須 説明
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 を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
title string テンプレートの title を上書きします。元のビュー名は変更しません。
null を許可: False
例: 巡检模板
取得または入力方法: エクスポートファイルに必要な表示タイトルを入力します。省略した場合はビュー名をそのまま使用します。

パラメータの補足説明

返却された JSON オブジェクトを使用して、チャート、レイアウト、グループ、変数を移行します。ワークスペースが異なる場合、外部データソースのバインドを確認する必要があります。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/dashboard/dsbd_inner_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.tagInfo[].name string テンプレートタグ名。
content.main object テンプレート内のチャート、変数、グループ。
content.main.type string 固定値は template です。
content.main.vars array<object> 変数定義の配列。
content.main.vars[].name string 変数名。
content.main.vars[].type string 変数の型。
content.main.vars[].definition object 変数定義。内容は型によって変わります。
content.main.vars[].seq integer 変数の順序。
content.main.vars[].code string 変数コード。変数の参照に使用します。
content.main.vars[].datasource string 変数のデータソース。
content.main.vars[].valueSort string 変数値の並べ替え方式。
content.main.vars[].hide integer 変数の非表示設定。
content.main.vars[].isHiddenAsterisk integer 非表示アスタリスクオプションの設定。
content.main.vars[].multiple boolean 複数選択を許可するかどうか。
content.main.vars[].includeStar boolean アスタリスクオプションを含めるかどうか。
content.main.vars[].extend object 変数の拡張設定。
content.main.charts array<object> チャート定義の配列。インポート時にチャート UUID が再作成されます。
content.main.charts[].uuid string ソースチャート UUID。
content.main.charts[].name string チャート名。
content.main.charts[].type string チャートタイプ。
content.main.charts[].chartGroupUUID string ソースチャートグループ UUID。
content.main.charts[].group.name string または null チャートグループ名。
content.main.charts[].prevGroupName string または null 以前のチャートグループ名。
content.main.charts[].pos object レイアウト内のチャートの位置とサイズ。
content.main.charts[].queries array<object> チャートのクエリ設定。
content.main.charts[].extend 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": "host-overview",
    "dashboardType": "CUSTOM",
    "dashboardExtend": {},
    "dashboardMapping": [],
    "dashboardBindSet": [],
    "iconSet": {},
    "main": {
      "type": "template",
      "charts": [],
      "vars": [],
      "groups": [],
      "chartGroupPos": []
    },
    "dashboardOwnerType": "inner",
    "tagInfo": [],
    "thumbnail": "",
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している パラメータの解析に失敗しました Query パラメータ表と例を確認してください。
404 ft.NotFoundView 対象が存在しない、削除済み、またはこのワークスペースに属していない 指定されたビューが見つかりません 同じワークスペースの組み込みビュー一覧から、まだ有効な UUID を取得してください。
403 ft.ForbiddenOperationResource API Key に対象ビューを操作する有効な権限がない 操作権限がありません ワークスペースの所属と API Key の権限を確認するか、リソース作成者に連絡してください。
403 ft.ForbiddenAccessResourceNoPublic プライベートビューにアクセスする識別情報がビュー作成時の識別情報と異なる リソースへのアクセス権限がありません。現在のページは非公開状態です アクセス権を持つ作成元の識別情報で操作し、同じワークスペースの API Key を使用していることを確認してください。
406 ft.InvalidParameter 履歴チャートのクエリ構造が無効で、有効なテンプレートとしてエクスポートできない パラメータ{}が無効です エラー内のフィールドパスに従って元のビューのチャート設定を確認し、修正してから再エクスポートしてください。

フィードバック

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