コンテンツにスキップ

識別子 ID インポート



POST /api/v1/board/import/identifier

概要

識別子に基づいてサイト全体で既存のダッシュボード/ユーザービューの内容を上書きする、またはシステムビューテンプレートを更新します。

呼び出し前と使用手順

サイトの w 権限を持つ External AK/SK が必要です(External API 署名認証)。このエントリポイントは workspaceUUID を受け付けず、identifier に基づいてサイト全体でアクティブな CUSTOM スペースオブジェクトおよび選択されたシステム言語テンプレートを選択します。事前にバックアップを取得し、同一識別子を持つすべてのリソースを洗い出してください。空でない正確な識別子を使用する必要があります。スペースのターゲットは完全な内容の上書きです。まず古いチャート/グループ/変数を論理削除し、ID を再生成してから、テンプレート内容を保存します。main、dashboardExtend、dashboardMapping などを省略しても元の値は保持されません。タイトルだけを変更したい場合は、スペーススコープを持つ通常の変更インターフェースを使用してください。title/summary/iconSet/バインディング設定にはそれぞれ「非空の場合のみ上書き」という互換ルールがあるため、旧説明の「未指定ならすべて保持」を適用することはできません。現在の実装では、同一バッチのスペースターゲットでテンプレートオブジェクトを再利用します。チャートの pos/group/uuid は最初のターゲット処理時にインプレースで取り出されるため、後続のターゲットではレイアウト/グループが変わる可能性があります。複数のターゲットで同じレイアウトを維持する必要がある場合は、各スペースの単一リソースインポートエントリに分割することを優先してください。このグローバルエントリではターゲットごとに検証する必要があり、HTTP200 だけを見て判断してはいけません。innerViewerZh/En は言語選択の起点にすぎません。クエリはまずリクエスト言語に非カスタムテンプレートがあることを要求し、カスタムテンプレートのみの場合、またはその言語のテンプレートがない場合はフォールバックできます(zh→en、en→zh)。そのため innerViewerEn が中国語テンプレートを選択して status=3(削除状態)に設定する可能性があり、両方の分岐を同時に選択すると同じテンプレートを先に更新してから削除する可能性があるため、「英語リソースのみを変更する」とは言えません。両分岐は最終テンプレート meta に元々存在するキーのみを上書きし、実際の UPDATE は status=0 のみに一致します。クエリが非0 のレコードを選択した場合、更新されなくても成功することがあります。実行前に identifier で2言語のシステム/カスタムレコードを洗い出し、最終的に選択される言語と UUID を確認してください。レスポンス配列はこれらのシステムテンプレートの更新結果を提供しません。各ターゲット/言語は個別にコミットされ、バッチ全体のロールバックや項目ごとのエラー結果はありません。失敗した場合、先行するターゲットはすでに更新されている可能性があります。タグのスコープが一致しない場合はスキップできますが、配列は skippedTags のサマリーを提供しません。成功時の content はスペースリソースの結果のみを列挙し、[] は一致なし、importType の未認識、またはシステムテンプレートのみを処理したことを表す場合があります。インポートではチャート UUID が再構築され、旧チャートに関連する外部参照は別途検証する必要があります。データソース/関数/変数はターゲットスペースで有効である必要があり、保存の成功はチャートクエリが実行可能であることを証明しません。

リクエストヘッダ

パラメータ名 型 必須 説明
X-Df-SVersion string 元のパスとリクエストボディの署名バージョン。省略したまま本ページのアルゴリズムを継続使用することはできません。
例: v20240417
取得または入力方法: 本ページの例ではこの固定バージョンを使用し、例の署名アルゴリズムと組み合わせます。
X-Df-Access-Key string Y 読み取りインターフェースでは r または w の認証情報を使用でき、書き込みインターフェースでは w の認証情報が必要です。
例: <external-access-key>
取得または入力方法: サイト管理者が割り当てた External API AK を使用します。ワークスペースの OpenAPI Key は使用できません。
X-Df-Nonce string Y 一時的なシリアル番号。失敗して再送する場合も新しい値を生成し、署名を再計算します。
例: 97d275ee9f774315a7885ba7347acbd9
取得または入力方法: リクエストごとに uuid.uuid4().hex を再生成します。
X-Df-Signature string Y 大文字のメソッド、nonce、元の完全なパス、timestamp、および元の UTF-8 リクエストボディをスペースで連結した後、HMAC-SHA256 を実行し、hex ダイジェストを取得します。
例: <hmac-sha256-hex>
取得または入力方法: External API 署名認証に従い、対応する SK を使用して計算します。完全な実行可能テンプレートは以下を参照してください。
X-Df-Timestamp string Y サイトで設定された署名有効時間枠内である必要があり、例の時刻を再利用することはできません。
例: 1785427200
取得または入力方法: 送信時に str(int(time.time())) を使用して現在の Unix 秒文字列を生成します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
importType[*] string 単一の上書きカテゴリ。中国語の表示名や ownerType 値で代替することはできません。
例: dashboard
取得または入力方法: 上記の4つの正確な文字列から選択します。
templateInfo.title string スペースリソースでは非空の真値の場合のみ name を置換します。省略/空文字列は旧タイトルを保持します。システムテンプレート分岐では meta に元々存在する同名キーのみを上書きし、空値も直接上書きします。
例: 业务指标
取得または入力方法: エクスポートしたテンプレートの title から調整します。
templateInfo.summary string スペースリソースでは非空の真値の場合のみ desc を置換します。省略/空文字列は旧説明を保持します。システム meta キーの上書きロジックとは異なります。
例: 核心业务指标
取得または入力方法: テンプレートの summary から調整します。
templateInfo.identifier string スペースリソースでは非空の場合のみ識別子を置換します。現在のグローバルパスでは単一スペースの一意性の外側チェックを行いません。変更後、次回は旧識別子では選択されなくなります。これを読み取り専用の位置指定キーとして扱わないでください。
例: my-unique-dashboard-template
取得または入力方法: 元のテンプレートの identifier を保持します。移行が本当に必要な場合は、事前に影響範囲を洗い出してください。
templateInfo.dashboardType string スペースインポートではデフォルトで CUSTOM に再設定され、旧 type を保持するわけではありません。CUSTOM を保持することを推奨します。main.type はこのフィールドではありません。
例: CUSTOM
取得または入力方法: 有効なエクスポートテンプレートのタイプを保持します。
templateInfo.dashboardExtend json スペースインポートでは extend 全体を上書きし、省略時はデフォルト {} です。増分マージと誤認しないでください。動的キーはエクスポート形式に従って保持します。
例: {}
取得または入力方法: エクスポートテンプレート内の完全なダッシュボード拡張設定をコピーします。
templateInfo.dashboardMapping array スペースインポートでは mapping 全体を上書きし、省略時はデフォルト [] です。各項目の動的 JSON は有効なエクスポート形式に従って保持します。本パスでは業務構造を補完しません。
例: []
取得または入力方法: エクスポートしたビュー変数のフィールドマッピング配列をコピーします。
templateInfo.dashboardMapping[*] json 単一の完全なマッピングオブジェクト。旧い空白のテーブルヘッダからマッピングキーを推測して作成しないでください。
例: {}
取得または入力方法: ターゲットテンプレート内の実際の単一マッピング設定をコピーします。
templateInfo.iconSet json スペースリソースではオブジェクトが非空の場合のみ置換し、省略または {} は元のアイコンを保持します。キーは元の設定に従って保存します。トップレベルの icon/thumbnail は現在のスペース分岐では個別に消費されません。
例: {"url": "", "icon": ""}
取得または入力方法: エクスポートしたアイコンオブジェクトを保持します。
templateInfo.iconSet.url string オプションのアイコン URL。表示するかどうかはクライアント設定に依存します。他ブランドの固定リソースドメインを使用しないでください。
例: https://example.com/icon.png
取得または入力方法: 自身のアクセス可能なアイコンリソースからアドレスを取得するか、元の値を保持します。
templateInfo.iconSet.icon string オプションの小アイコン設定値。実際の構造は元のエクスポートに従います。
例: chart
取得または入力方法: コンソールからエクスポートしたアイコン識別子/設定を保持します。
templateInfo.dashboardBindSet array 非空の真値の場合のみ置換します。省略/[] は旧バインディングを保持し、クリアではありません。
例: []
取得または入力方法: ターゲットの有効なエクスポートテンプレートから完全なバインディング設定を保持します。
templateInfo.dashboardBindSet[*] json 元のバインディング設定の動的構造に従って保存します。本エントリポイントではリソースの帰属を完全には検証しません。
例: {}
取得または入力方法: 有効なエクスポートの1つのバインディングオブジェクトをコピーします。
templateInfo.tags array node スペースのダッシュボードでは名前でタグの関連付けをリセットし、非空の tags を優先して使用します。省略/[] の場合は tagInfo を試み、どちらもなければクリアします。同名の非 scene/all タグはインポートコンテキストでスキップされ、旧い関連付けをクリアする可能性があります。配列レスポンスは skippedTags のサマリーを提供しません。userViewer の実際の inner 分岐はこれらのシーンタグ更新を通りません。
例: ["production"]
取得または入力方法: ターゲットスペースに既存の scene/all タグ名、または必要な業務タグから選択します。事前にスコープを確認してください。
templateInfo.tags[*] string 単一のタグ名。最大 128 文字です。新しい名前はターゲットスペースで scene タグを作成できます。
例: production
取得または入力方法: 対応するタグの name をコピーします。tag_UUID は使用しません。
templateInfo.tagInfo array tags に非空値がない場合のみ、各項目の name でタグを選択します。セマンティクスは tags と同じです。追加ではありません。tagInfo.uuid でクロススペースタグを指定することはできません。
例: [{"name": "production"}]
取得または入力方法: 互換エクスポート形式に既存の tagInfo がある場合は保持します。
templateInfo.tagInfo[*] json name のみを読み取り、その他のクライアント表示フィールドは関連付けを決定しません。
例: {"name": "production"}
取得または入力方法: 有効なエクスポートのタグ情報からコピーします。
templateInfo.tagInfo[*].name string 単一のタグ名。
例: production
取得または入力方法: ターゲットの既存/新規業務タグ名から取得します。
templateInfo.main json チャート、グループ、変数の完全なターゲット。省略または {} は空の集合として再構築されるため、タイトルのみを変更するパッチとしては使用できません。
例: {"groups": [], "charts": [], "vars": []}
取得または入力方法: 完全で有効なエクスポートテンプレートの main をコピーします。
templateInfo.main.type string 旧テンプレートのシステムタイプ情報。現在のスペース再構築ではこれで dashboardType を代替しません。
例: dashboard
取得または入力方法: 元のテンプレート内のシステムマーカーを保持します。
templateInfo.main.groups array グループリスト。名前文字列または {name,extend} オブジェクトをサポートします。同名は重複排除されます。省略時は [] でクリアし、グループ UUID を再生成します。
例: ["业务指标"]
取得または入力方法: エクスポートテンプレートのグループ順序からコピーし、変更時はチャートの group がその名前に対応するようにします。
templateInfo.main.groups[*] string または object 文字列はグループ名です。オブジェクトは name/extend を読み取り、name が空のオブジェクトは無視されます。グループ名は最大 256 文字です。
例: {"name": "业务指标", "extend": {}}
取得または入力方法: エクスポートしたグループ構造からコピーします。
templateInfo.main.groups[*].name string オブジェクト形式のグループ名。空にはできません。チャートは同名の group でグループ化されます。
例: 业务指标
取得または入力方法: 自分でグループ名を定義するか、既存のエクスポート名をコピーします。
templateInfo.main.groups[*].extend json オプションのグループ拡張オブジェクト。省略時は {} です。
例: {}
取得または入力方法: グループの折りたたみなどのエクスポート設定を保持します。
templateInfo.main.charts array 完全なチャート集合。省略時は [] で旧チャートを削除し、再構築しません。旧 chart UUID は削除され、新しい ID が生成されます。
例: []
取得または入力方法: 有効なエクスポートテンプレートから完全なチャート配列をコピーします。詳細の chartPos で代替することはできません。
templateInfo.main.charts[*] json チャートオブジェクト。type が文字列、queries が配列、各 query がオブジェクトであることを検証します。すべてのクライアント拡張キーがサーバー側で完全に検証されるわけではありません。
例: {"name": "CPU空闲", "type": "line", "queries": [{"qtype": "dql", "query": {"q": "M::`cpu`:(`usage_idle`)"}}], "pos": {"x": 0, "y": 0, "w": 12, "h": 6}}
取得または入力方法: コンソールで検証済みのチャートエクスポートオブジェクトからコピーし、実際のクエリ文を変更します。
templateInfo.main.charts[*].name string 未指定または空値は空タイトルになります。最大 256 文字です。
例: CPU空闲
取得または入力方法: チャートの表示名を入力します。
templateInfo.main.charts[*].type string デフォルトは line で、保存時に小文字になります。現在は sequence のみではありません。サポートされるタイプはコンソールのエクスポートに従います。
例: line
取得または入力方法: 有効なエクスポートのチャートタイプを保持します(例: line や combine)。
templateInfo.main.charts[*].uuid string 指定しても破棄され、新しいチャート ID が再構築されます。旧チャートの関連付けを保持するために使用することはできません。
例: chrt_example
取得または入力方法: 旧エクスポートから含まれる場合がありますが、通常の呼び出しでは入力不要です。
templateInfo.main.charts[*].group json 文字列のグループ名、{name:グループ名}、または null を指定できます。対応するグループがない場合は default に分類されます。オブジェクトは name で解析されます。
例: {"name": "业务指标"}
取得または入力方法: 今回の main.groups 内の名前と正確に一致させます。
templateInfo.main.charts[*].group.name string グループ名。null はグループ化しないことを表します。
例: 业务指标
取得または入力方法: 今回の main.groups 内の name を参照します。
templateInfo.main.charts[*].pos json レイアウトオブジェクト。省略時は {} です。クライアントのレイアウト単位で解釈され、サーバー側ではそのまま保存されます。旧説明の string を強制的な数値契約として扱いません。
例: {"x": 0, "y": 0, "w": 12, "h": 6}
取得または入力方法: エクスポートしたレイアウトからコピーします。
templateInfo.main.charts[*].pos.x number 横位置。クライアントのグリッド単位です。
例: 0
取得または入力方法: エクスポートしたグリッドの横座標をコピーします。
templateInfo.main.charts[*].pos.y number 縦位置。
例: 0
取得または入力方法: エクスポートしたグリッドの縦座標をコピーします。
templateInfo.main.charts[*].pos.w number 幅。
例: 12
取得または入力方法: エクスポートしたグリッドの幅をコピーします。
templateInfo.main.charts[*].pos.h number 高さ。
例: 6
取得または入力方法: エクスポートしたグリッドの高さをコピーします。
templateInfo.main.charts[*].pos.i string オプションのクライアントレイアウトマーカー。新しいチャートの実際の UUID としては使用されません。
例: chart-position
取得または入力方法: 元のエクスポートの表示マーカーがあれば保持します。
templateInfo.main.charts[*].extend json チャート全体の拡張オブジェクト。省略時は {} です。そのネストされたキーはチャートタイプによって動的であり、現在は元の JSON のまま保存され、必要なクライアント設定を自動補完しません。
例: {}
取得または入力方法: 有効なエクスポートの settings/style などのチャート拡張設定を完全に保持します。
templateInfo.main.charts[*].queries array 通常のチャートではクエリオブジェクトの配列です。combine の外側は子チャートオブジェクトで、各子チャートは自身の queries 配列を含みます。配列を文字列/単一オブジェクトで代替してはいけません。
例: [{"qtype": "dql", "query": {"q": "M::`cpu`:(`usage_idle`)"}}]
取得または入力方法: 検証済みのチャートエクスポートのクエリ構造からコピーします。
templateInfo.main.charts[*].queries[*] json 通常のクエリオブジェクトは qtype/query を読み取り、追加の表示キーは保持されます。combine の子チャート uuid は最初の main およびその他の一意な内部 ID に正規化され、ネストされた queries は再帰的に検証されます。
例: {"qtype": "dql", "query": {"q": "M::`cpu`:(`usage_idle`)"}}
取得または入力方法: 通常はエクスポートしたクエリオブジェクトを使用し、combine ではエクスポートした完全な子チャートオブジェクトを使用します。
templateInfo.main.charts[*].queries[*].qtype string 通常のクエリタイプ。本インポート呼び出しではクエリを実行したり、業務データの存在を検証したりしません。
例: dql
取得または入力方法: dql/promql など実際のクエリ構文タイプを使用します。
templateInfo.main.charts[*].queries[*].query json 通常のクエリパラメータの動的オブジェクト。query キーがある場合はオブジェクトである必要があり、時間/変数/データソースのフィールドは有効なエクスポートに従って保持されます。本エントリポイントでは保存のみを行い、これを使って同期的にデータクエリを実行しません。
例: {"q": "M::`cpu`:(`usage_idle`)"}
取得または入力方法: 有効なエクスポートのクエリオブジェクトをコピーします。実際のフィールドについては同期クエリパラメータを参照してください。
templateInfo.main.charts[*].queries[*].query.q string 通常のクエリ文。テンプレート変数を含めることができます。クロススペーステンプレートでは実際のデータセット/フィールド/変数が利用可能か確認する必要があります。
例: M::`cpu`:(`usage_idle`)
取得または入力方法: ターゲットスペースのクエリツールで検証した後、DQL/PromQL をコピーします。
templateInfo.main.charts[*].queries[*].query.outerDatasourceInfo json マネージド参照は configMd5 に基づいてターゲットスペースで uuid を再バインドします。一致するものが見つからない場合は旧スペース uuid を削除しますがダイジェストは保持し、データソースは作成しません。funcServerId などの関数参照はターゲットスペースの設定を確認する必要があり、本パスは完全なリソース移行ではありません。
例: {"configMd5": "<exported-config-digest>"}
取得または入力方法: マネージド外部データソース参照はエクスポートした configMd5 を保持し、事前に各ターゲットスペースで同じ内容のデータソースを設定してください。
templateInfo.main.charts[*].queries[*].query.outerDatasourceInfo.configMd5 string ターゲットデータソース設定の一致ダイジェスト。
例: <exported-config-digest>
取得または入力方法: 有効なエクスポート値をそのまま使用し、業務ダイジェストを手動で生成しません。
templateInfo.main.charts[*].queries[*].queries array 組み合わせ子チャートの階層でのみ使用され、内部構造は通常の queries と一致し、再帰可能です。通常の query オブジェクトとして扱わないでください。
例: []
取得または入力方法: combine チャートでは有効なエクスポートの子チャートクエリ配列を保持します。
templateInfo.main.vars array 完全な変数集合。省略時は [] でクリアします。配列順に seq を 0 から再設定し、UUID を生成します。
例: []
取得または入力方法: 有効なエクスポートの完全なビュー変数配列をコピーします。
templateInfo.main.vars[*] json 変数オブジェクト。name/code/type は strip され、type は大文字になります。変数タイプごとに異なる definition/extend の動的構造はコンソールの有効なエクスポートを保持する必要があり、サーバー側ではここでフロントエンドのセマンティクスを全面的に検証しません。
例: {"name": "主机", "code": "host", "type": "QUERY", "definition": {}}
取得または入力方法: ターゲットで利用可能なテンプレートから変数オブジェクトをエクスポートし、名前から definition 形式を推測しません。
templateInfo.main.vars[*].name string 表示名。デフォルトは空で、前後の空白を除去します。
例: 主机
取得または入力方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。
templateInfo.main.vars[*].code string 変数コード。デフォルトは空で、前後の空白を除去します。クエリ内の変数参照と一致する必要があります。
例: host
取得または入力方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。
templateInfo.main.vars[*].type string 変数タイプ。デフォルトは空で、その後大文字に変換されます。コンソールの有効なエクスポートタイプを使用します。
例: QUERY
取得または入力方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。
templateInfo.main.vars[*].definition json 変数タイプごとにエクスポート定義を完全にコピーします。デフォルトは {} です。
例: {}
取得または入力方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。
templateInfo.main.vars[*].datasource string オプションのデータソースタイプ。デフォルトは空文字列で、元のエクスポートに従って保持します。
例: metric
取得または入力方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。
templateInfo.main.vars[*].valueSort string オプションの値ソート。デフォルトは空文字列です。
例: asc
取得または入力方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。
templateInfo.main.vars[*].hide integer 非表示表示スイッチ。デフォルトは 0 です。
例: 0
取得または入力方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。
templateInfo.main.vars[*].isHiddenAsterisk integer 非表示アスタリスクオプションのスイッチ。デフォルトは 0 です。
例: 0
取得または入力方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。
templateInfo.main.vars[*].multiple boolean 複数選択かどうか。デフォルトは true です。
例: true
取得または入力方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。
templateInfo.main.vars[*].includeStar boolean アスタリスクオプションを含めるかどうか。デフォルトは true です。
例: true
取得または入力方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。
templateInfo.main.vars[*].extend json 変数拡張オブジェクト。デフォルトは {} で、元のエクスポートに従って完全にコピーします。
例: {}
取得または入力方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。
templateInfo.main.vars[*].seq integer インポート時は配列位置で再計算され、この値で最終順序を制御しません。
例: 0
取得または入力方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。
identifier string Y 必須の文字列。サイト全体で現在アクティブな CUSTOM リソースおよび選択カテゴリに正確に一致し、ワークスペースを限定しません。空文字列を渡さないでください(現在は非空を強制していないため、識別子のない多数のオブジェクトに一致する可能性があります)。事前に同一識別子を持つすべてのリソースを洗い出してください。これはリソース UUID ではありません。
null 許可: False
例: my-unique-dashboard-template
取得または入力方法: 更新予定のダッシュボード/ビュー詳細またはエクスポートテンプレートの identifier から、実在し非空の識別子を取得します。
importType array Y 必須の配列。dashboard は ownerType=node のスペースダッシュボードを更新します。userViewer は実際には ownerType=inner のスペースユーザービューに一致します。innerViewerZh/En はそれぞれ zh/en を言語クエリの起点とし、実際にはフォールバックします(zh→en、en→zh)。言語分離の保証ではありません。その言語のカスタムテンプレートのみが存在しても優先的にヒットする保証はありません。未知の値は無視され、[] は処理しません。これでスペースを指定することはできません。
null 許可: False
例: ["dashboard"]
取得または入力方法: 必要に応じて dashboard、userViewer、innerViewerZh、innerViewerEn の1つ以上を選択します。操作前にサイト全体への影響を確認してください。
templateInfo json 宣言上は任意ですが、実際には完全なターゲットとして提供する必要があります。省略/{} は元の内容を保持するわけではありません。各スペースターゲットは引き続き旧チャート/グループ/変数を削除し、レイアウト/extend/mapping などをリセットします。本ページは既存の一致リソースの上書きに使用され、一致しないスペースリソースは作成しません。
空文字列許可: False
null 許可: False
例: {"title": "业务指标", "main": {"groups": [], "charts": [], "vars": []}}
取得または入力方法: 検証済みのダッシュボード/ユーザービューエクスポートテンプレートから完全なオブジェクトを取得し、各ターゲットを事前にバックアップしてください。詳細エンティティをそのままテンプレートとして扱わないでください。

パラメータ補足説明

本インターフェースはサイトレベルのグローバル上書きであり、テンプレートファイルのアップロードやダッシュボードの新規作成ではありません。スペースごとのページング、dryRun、非同期タスクの進捗、バッチトランザクションはサポートしません。テンプレートを渡さないことは事前チェックを意味しません。テンプレートの main/チャート/変数/拡張内のその他のクライアント動的キーは有効なエクスポートに従います。未知のキーはサーバー側がサポートを約束することを意味しません。リソースの実際のフィールドは、本ページで明示的に消費されるキーに従います。

リクエスト例

import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen

# ターゲットサイトのアドレスおよび管理者が割り当てた External API AK/SK に置き換えてください。
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'POST'
path = '/api/v1/board/import/identifier'
query = {}
data = {'importType': ['dashboard'], 'identifier': 'my-unique-dashboard-template', 'templateInfo': {'title': '业务指标', 'dashboardType': 'CUSTOM', 'dashboardExtend': {}, 'dashboardMapping': [], 'main': {'groups': [], 'charts': [], 'vars': []}}}
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
    "X-Df-Access-Key": access_key,
    "X-Df-Timestamp": timestamp,
    "X-Df-Nonce": nonce,
    "X-Df-Signature": signature,
    "X-Df-SVersion": "v20240417",
}
if data is not None:
    headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
    print(result.read().decode("utf-8"))

レスポンス

HTTP200、application/json の標準 External シェルで、content は配列です。declaration、総数、システムテンプレートの結果、ターゲットごとの失敗リストはありません。返されるのは今回実行されたスペースリソースのエンティティスナップショットであり、完全な新規チャート/変数の詳細は含みません。

フィールド 型 説明
content オブジェクト配列 スペース dashboard/userViewer の一致オブジェクトの更新結果のみ。一致なし、またはシステムテンプレートのみを処理した場合も [] を返し、ターゲットごとの実行レポートではありません。
content[].id integer ダッシュボードレコード番号。
content[].uuid string ダッシュボード UUID。詳細、変更、削除、カルーセルに使用します。
content[].workspaceUUID string 所属ワークスペース。
content[].name string ダッシュボードの表示名。
content[].desc string ダッシュボードの説明。
content[].identifier string 対外的なカスタム識別子。空の場合があります。
content[].ownerType string 本エントリポイントでは dashboard は node、userViewer は現在の実装では inner です。ownerType=viewer ではありません。
content[].type string ダッシュボードタイプ(例: CUSTOM)。
content[].chartPos array<object> チャートレイアウト配列。各項目の chartUUID はチャート識別子、pos はレイアウトオブジェクトです。
content[].chartPos[].chartUUID string 関連付けられたチャート UUID。
content[].chartPos[].pos object チャートのサイズと位置(例: x、y、w、h)。
content[].chartGroupPos array<string> チャートグループ識別子の並び順。
content[].iconSet object アイコン設定。
content[].isPublic integer 1 は公開、0 は作成者のみ表示、-1 はカスタム権限。
content[].extend object 拡張設定。
content[].mapping array<object> 変数フィールドマッピング。
content[].createdWay string 今回の書き込みでは import になります。
content[].dashboardBindSet array ビューバインディング設定。
content[].openPermissionSet boolean 現在カスタム権限が有効かどうか。
content[].permissionSet array<string> 操作権限主体の UUID リスト。
content[].readPermissionSet array<string> 読み取り権限主体の UUID リスト。
content[].tagInfo array<object> 本レスポンスに関連するタグ情報。
content[].tagInfo[].id string タグ識別子。uuid と同じです。
content[].tagInfo[].uuid string タグ UUID。
content[].tagInfo[].name string 関連付けられたタグ名。
content[].tagInfo[].description string タグの説明。
content[].tagInfo[].colour string タグの色。
content[].tagInfo[].scope array<string> タグの適用範囲。
content[].tagInfo[].tagPermissionInfo object タグ認可が存在する場合に付随する操作権限と読み取り権限の情報。
content[].status integer レコードステータス。
content[].creator string 作成者のアイデンティティ ID。
content[].updator string このパスでは Dashboard の更新アイデンティティを能動的に更新しないため、旧い値のままである可能性があります。sys である保証はありません。
content[].createAt number 作成時刻(Unix 秒)。
content[].updateAt number このパスで内容を再構築する際は Dashboard._update_time を能動的に呼び出さないため、元の更新時刻のままである可能性があります。これによって本バッチが反映されたかどうかを判断することはできません。
content[].deleteAt number 削除時刻(Unix 秒)。未削除の場合は -1。
content[].creatorInfo object 作成者情報。空のオブジェクトの場合があります。
content[].updatorInfo object 最新更新者情報。空のオブジェクトの場合があります。
content[].iconSet.url string オプションのアイコン URL。
content[].iconSet.icon JSON 値 オプションの小アイコン設定。
content[].chartPos[].pos.x number 横方向のグリッド位置。
content[].chartPos[].pos.y number 縦方向のグリッド位置。
content[].chartPos[].pos.w number 幅。
content[].chartPos[].pos.h number 高さ。
content[].mapping[] object 完全なマッピング項目。動的キーは元のテンプレートに従います。
content[].extend.その他のキー JSON 値 ダッシュボード拡張の元の値。
content[].tagInfo[].tagPermissionInfo.permissionSet 文字列配列 オプションの操作権限主体。
content[].tagInfo[].tagPermissionInfo.readPermissionSet 文字列配列 オプションの読み取り権限主体。
content[].creatorInfo.uuid string アイデンティティ UUID。システムアイデンティティの場合は空になります。
content[].creatorInfo.status integer アカウントレコードステータス。
content[].creatorInfo.wsAccountStatus integer オプションのステータス。サマリー読み取りではターゲットスペースを渡さないため、ターゲットスペースのメンバーが有効であることを証明するものではありません。
content[].creatorInfo.username string ログイン名。
content[].creatorInfo.name string 表示名。
content[].creatorInfo.iconUrl string オプションのアバター。
content[].creatorInfo.email string メールアドレスまたはシステムアイデンティティの表示。
content[].creatorInfo.mobile string オプションの携帯電話番号。
content[].creatorInfo.countryCode string オプションの携帯電話番号の国コード。
content[].creatorInfo.acntWsNickname string オプションのスペースニックネーム。
content[].updatorInfo.uuid string アイデンティティ UUID。システムアイデンティティの場合は空になります。
content[].updatorInfo.status integer アカウントレコードステータス。
content[].updatorInfo.wsAccountStatus integer オプションのステータス。サマリー読み取りではターゲットスペースを渡さないため、ターゲットスペースのメンバーが有効であることを証明するものではありません。
content[].updatorInfo.username string ログイン名。
content[].updatorInfo.name string 表示名。
content[].updatorInfo.iconUrl string オプションのアバター。
content[].updatorInfo.email string メールアドレスまたはシステムアイデンティティの表示。
content[].updatorInfo.mobile string オプションの携帯電話番号。
content[].updatorInfo.countryCode string オプションの携帯電話番号の国コード。
content[].updatorInfo.acntWsNickname string オプションのスペースニックネーム。
content[].tagInfo[].tagPermissionInfo.id integer タグ認可レコードの番号。
content[].tagInfo[].tagPermissionInfo.uuid string タグ認可レコード UUID。
content[].tagInfo[].tagPermissionInfo.workspaceUUID string 所属スペース。
content[].tagInfo[].tagPermissionInfo.tagUUID string タグ UUID。
content[].tagInfo[].tagPermissionInfo.type string 認可リソースタイプ。デフォルトは dashboard。
content[].tagInfo[].tagPermissionInfo.status integer アクティブレコードは 0。
content[].tagInfo[].tagPermissionInfo.creator string 作成アイデンティティ。
content[].tagInfo[].tagPermissionInfo.updator string 更新アイデンティティ。
content[].tagInfo[].tagPermissionInfo.createAt integer 作成 Unix 秒。
content[].tagInfo[].tagPermissionInfo.updateAt integer 更新 Unix 秒。
content[].tagInfo[].tagPermissionInfo.deleteAt integer 削除 Unix 秒。未削除の場合は -1。
content[].tagInfo[].tagPermissionInfo.permissionSetInfo object オプションの操作権限主体から表示情報へのマッピング。アカウントサマリーまたはロール/チームの name/status。
content[].tagInfo[].tagPermissionInfo.readPermissionSetInfo object オプションの読み取り権限主体の表示情報マッピング。
content[].tagInfo[].tagPermissionInfo.permissionSetInfo.識別子 object 主体の表示オブジェクト。
content[].tagInfo[].tagPermissionInfo.permissionSetInfo.識別子.uuid string アカウントのオプション UUID。
content[].tagInfo[].tagPermissionInfo.permissionSetInfo.識別子.name string 表示名。
content[].tagInfo[].tagPermissionInfo.permissionSetInfo.識別子.status integer レコードステータス。
content[].tagInfo[].tagPermissionInfo.permissionSetInfo.識別子.wsAccountStatus integer アカウントのスペースステータス。
content[].tagInfo[].tagPermissionInfo.permissionSetInfo.識別子.username string アカウントのログイン名。
content[].tagInfo[].tagPermissionInfo.permissionSetInfo.識別子.iconUrl string オプションのアバター。
content[].tagInfo[].tagPermissionInfo.permissionSetInfo.識別子.email string オプションのメールアドレス。
content[].tagInfo[].tagPermissionInfo.permissionSetInfo.識別子.mobile string オプションの携帯電話番号。
content[].tagInfo[].tagPermissionInfo.permissionSetInfo.識別子.countryCode string オプションの国コード。
content[].tagInfo[].tagPermissionInfo.permissionSetInfo.識別子.acntWsNickname string オプションのスペースニックネーム。
content[].tagInfo[].tagPermissionInfo.readPermissionSetInfo.識別子 object 主体の表示オブジェクト。
content[].tagInfo[].tagPermissionInfo.readPermissionSetInfo.識別子.uuid string アカウントのオプション UUID。
content[].tagInfo[].tagPermissionInfo.readPermissionSetInfo.識別子.name string 表示名。
content[].tagInfo[].tagPermissionInfo.readPermissionSetInfo.識別子.status integer レコードステータス。
content[].tagInfo[].tagPermissionInfo.readPermissionSetInfo.識別子.wsAccountStatus integer アカウントのスペースステータス。
content[].tagInfo[].tagPermissionInfo.readPermissionSetInfo.識別子.username string アカウントのログイン名。
content[].tagInfo[].tagPermissionInfo.readPermissionSetInfo.識別子.iconUrl string オプションのアバター。
content[].tagInfo[].tagPermissionInfo.readPermissionSetInfo.識別子.email string オプションのメールアドレス。
content[].tagInfo[].tagPermissionInfo.readPermissionSetInfo.識別子.mobile string オプションの携帯電話番号。
content[].tagInfo[].tagPermissionInfo.readPermissionSetInfo.識別子.countryCode string オプションの国コード。
content[].tagInfo[].tagPermissionInfo.readPermissionSetInfo.識別子.acntWsNickname string オプションのスペースニックネーム。
{
  "code": 200,
  "content": [],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 パラメータ解析失敗 パラメータの位置、フィールド名、型、値を確認します。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効 リクエスト JSON の形式エラー content.reason、line、column に従って JSON を修正します。
400 ft.JsonFormatError JSON のトップレベルがオブジェクトでない 一部の json ファイルの形式エラー JSON オブジェクトを送信します。
406 ft.InvalidParameter テンプレート main/groups/charts/vars 構造、チャート type/group、または queries/query 構造が不正 パラメータ {} が無効 完全で有効なエクスポートテンプレートを使用し、content.reason/エラーパラメータパスに従って修正します。
406 ft.ExceedMaxCharacterLimit チャート/グループ名が 256 文字を超える、またはタグ名が 128 文字を超える {} が最大文字数制限を超えています 名前を短縮します。サイト全体の上書きを開始する前に、すべてのターゲットテンプレートを検証してください。
404 ft.NotFoundView 検出済みのスペースリソースが後続のインポート前に消失/削除された 指定されたビューが見つかりません サイト全体の同一識別子リソースを再び洗い出します。ターゲットが完了していることを確認してから処理します。
500 ft.InternalServerError 旧内容、テンプレートタイプ、マネージドデータソース/タグ/設定、データベース、または返却情報の処理異常 内部エラー traceId を保持し、事前のバックアップに従ってターゲットごとに現在のチャート/グループ/変数/システムテンプレートの状態を確認します。バッチ全体を盲目的に再実行しないでください。一部のターゲットはすでにコミットされている可能性があります。

フィードバック

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