テンプレート - カスタムシステムテンプレートのインポート¶
POST /api/v1/sys_template/custom/import
概要¶
サイトレベルのカスタムシステムテンプレートをインポートまたは完全上書きし、入力ごとの診断結果を返します。
呼び出し前の確認と使用手順¶
これはサイトレベルのテンプレートライブラリであり、特定のワークスペースで既に作成済みのダッシュボード/モニター/Pipeline インスタンスではありません。ライブラリのテンプレートを削除または上書きしても、インスタンス化済みのリソースが削除/アップグレードされるわけではありません。本モジュールはデータクエリを実行せず、稼働中の収集設定を公開することもありません。w 権限での署名が必要です。まずテンプレートリストで type/language/isCustomSysTemp=true を指定して同名テンプレートを洗い出し、テンプレート詳細の内容をバックアップします。その後、以下の型ごとのルールに従って jsonContents を構築します。isCover=false は初回インポート用で、true を指定すると一致するカスタムターゲットの上書きが許可されます。Pipeline 以外の名前は通常、型+完全一致する言語で重複判定され、固定エクスプローラーは fileName、Pipeline は category+name に加えて共通言語も含めて判定されます。dashboard はさらに identifier もチェックします。HTTP200 の content の各項目の err_fields とすべての競合ブールフィールドを確認する必要があります。ブロック項目が1つでもあると、このインポート分岐はバッチ全体がコミットされません。success=true を有効化済みとみなしてはいけません。[] でもデータがインポートされたとは限りません(たとえば pipeline ラッパー内に pipelines がない場合)。リスト/詳細で実際のレコードを確認して初めて完了となります。レスポンスには UUID が含まれないため、後続処理では再度リストから特定する必要があります。上書き時は meta 全体、および Pipeline がサポートする内容と source などの列を更新し、設定の漏れをマージして保持することはありません。Pipeline の上書きでは testData が現在も旧値のままである可能性があるため、GET でデコードして検証する必要があります。一部の GET フィールドは Pipeline インポートでは明確に無視され、RUM のアプリケーションバインドはクリアされます。この呼び出しはテンプレートライブラリのみを変更し、既存のワークスペースリソースには自動適用されません。通常の異常 500 や呼び出しタイムアウトの後は、まず現在の状態を読み取ってください。上書きを再実行すると更新時刻が再び変わる可能性があります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| X-Df-SVersion | string | 元のパスとリクエストボディの署名バージョン。省略したまま本ページのアルゴリズムを継続使用することはできません。 例: v20240417取得・記入方法: 本ページの例ではこの固定バージョンを使用し、サンプル署名アルゴリズムと組み合わせています。 |
|
| X-Df-Access-Key | string | Y | 読み取り API では r または w の認証情報を使用でき、書き込み API では 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 リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| jsonContents[*] | json | 単一のエクスポートテンプレート内容。動的フィールドは項目ごとの完全な schema 検証を受けず、null やオブジェクト以外は 500 になる可能性があります。 例: {"title": "业务指标", "identifier": "business-dashboard", "main": {"groups": [], "charts": [], "vars": []}}取得・記入方法: 同じカテゴリの有効なテンプレート詳細オブジェクトをコピーします。 |
|
| jsonContents[*].title | string | dashboard/security/customer-explorer などの汎用分岐ではこのフィールドからテンプレート名を取得し、trim 後に非空である必要があります。monitor はこのフィールドで検出ライブラリ名を決定しません。 例: 业务指标取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].summary | string | 汎用 meta 内の概要はそのまま保存されます。monitor はトップレベルの summary で再構築します。 例: 业务指标说明取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].identifier | string | dashboard 専用の識別子。既存のシステムテンプレートおよび本バッチの他のテンプレートと競合しない必要があります。同名かつ同一識別子が同一のカスタムレコードを指す場合は上書きが許可されますが、別の名前が使用している識別子を上書きすることはできません。 例: business-dashboard取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].isHidden | boolean | 汎用/エクスプローラー分岐では true または数値 1 のみを非表示として扱い、それ以外は表示します。monitor は固定で false です。 例: false取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].iconSet | json | テンプレートアイコンの JSON は有効な詳細どおりに完全保持されます。monitor では url が空文字列に再構築されます。 例: {"url": ""}取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main | json または array | type によって変化します。dashboard はオブジェクト、monitor は {checkers} オブジェクト、エクスプローラーはパネル配列です。汎用の security などは元の構造を保持します。ここではテンプレートを保存するだけであり、すべての業務構造が実行可能な検証を通過したことを意味しません。 例: {"groups": [], "charts": [], "vars": []}取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main.groups | array | dashboard のグループ設定を完全に保存します。実際の適用時は識別子インポートパラメータを参照してください。 例: []取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main.charts | array | dashboard のグラフ配列を完全に保存します。本テンプレートライブラリのインポートではワークスペースダッシュボードのグラフ構造/クエリの事前チェックを呼び出さないため、後続のインスタンス化で失敗する可能性があります。 例: []取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main.vars | array | dashboard の変数配列を有効なエクスポートどおりに完全保存します。実際の適用時には変数レコードが再生成されます。 例: []取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].checkers | array | monitor の互換用トップレベル検出器配列で、main.checkers とはどちらか一方を使用します。このキーが存在する場合は優先され、内容が無効でもフォールバックしません。 例: [{"jsonScript": {"title": "CPU异常", "type": "simpleCheck"}}]取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].checkers[*] | json | 完全なモニター定義。インポート時は jsonScript.title/type の重要フィールドをチェックし、その他の設定も有効なエクスポートである必要があります。 例: {"jsonScript": {"title": "CPU异常", "type": "simpleCheck"}}取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].checkers[*].jsonScript | json | 検出器の実際の設定オブジェクト。 例: {"title": "CPU异常", "type": "simpleCheck"}取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].checkers[*].jsonScript.title | string | monitor の実際のサブチェッカータイトルで、非空である必要があります。 例: CPU异常取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].checkers[*].jsonScript.type | string | 現在の RULE_CHECK_CFG 集合に含まれている必要があります。有効化済み/エクスポート可能なモニターから取得し、未記入の場合は中国語が表示されます。 例: simpleCheck取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main.checkers | array | monitor の標準エクスポート位置で、トップレベル checkers がない場合にのみ読み取られます。複数項目の jsonContents 検出器はトップレベル title で定義された1つのテンプレートにマージされ、各 monitorName はその title で上書きされます。 例: [{"jsonScript": {"title": "CPU异常", "type": "simpleCheck"}}]取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main.checkers[*] | json | 完全な検出器オブジェクトで、意味はトップレベル checkers の項目と同じです。 例: {"jsonScript": {"title": "CPU异常", "type": "simpleCheck"}}取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main.checkers[*].jsonScript | json | 検出器の設定。 例: {"title": "CPU异常", "type": "simpleCheck"}取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main.checkers[*].jsonScript.title | string | 非空の検出器表示タイトル。 例: CPU异常取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main.checkers[*].jsonScript.type | string | サポートされているモニター内部型の文字列。 例: simpleCheck取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main[] | json | エクスプローラーのパネル項目。object-explorer は最初の項目の class/source を参照し、resource-catalog も最初の項目を参照します。固定専用エクスプローラーは最初のテンプレートの各パネルを走査します。 例: {"class": "object", "source": {"key": "kubernetes_nodes", "name": "Nodes"}}取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main[].class | string | object-explorer は object、resource-catalog-explorer は custom_object である必要があります。その他の固定型は元の有効なパネルカテゴリどおりに保持します。 例: object取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main[].source | string または object または array | ソースキー文字列、{key,name} オブジェクト、またはそのオブジェクトを先頭に持つ配列を指定できます。実際の業務ソースキーを使用します。固定型のインポートでは {key,name} に正規化され、object の最初の項目はシステム定義の設定に置き換えられます。 例: {"key": "kubernetes_nodes", "name": "Nodes"}取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main[].source.key | string | ソースキー。object-explorer は下表の定義済みキーのみ使用でき、resource-catalog は実際のカスタムオブジェクトソースキーを使用します。 例: kubernetes_nodes取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main[].source.name | string | 表示エイリアス。object-explorer の最初の項目は固定設定で再設定され、その他の型はエクスポートされたエイリアスを保持します。 例: Nodes取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main[].table | JSON 値 | エクスプローラーのテーブル設定。コンソールの有効な詳細どおりに完全コピーしてください。現在は保存のみで、列定義は自動補完されません。 例: {}取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main[].filters | JSON 値 | エクスプローラーのフィルター編集設定。元のエクスポート構造どおりに保持します。 例: {}取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].main[].searchFilterKeys | array | エクスプローラーの検索フィールドリスト。元のエクスポート構造どおりに保持します。本 API は各エディター設定を完全には検証しません。 例: []取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines | array | pipeline 専用のラッパーで、各外側オブジェクトに複数の Pipeline を含めることができます。省略または [] の場合は空の診断が生成されてインポートされないため、少なくとも1件あることを自身で確認する必要があります。 例: [{"category": "logging", "name": "example_pipeline", "source": [], "content": "YWRkX2tleSgiZXhhbXBsZSIsICJ2YWx1ZSIp", "testData": "eyJzYW1wbGUiOnsibWVzc2FnZSI6ImV4YW1wbGUifX0=", "extend": {}}]取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*] | json | 単一の Pipeline テンプレート定義で、content/testData も併せて補う必要があります。 例: {"category": "logging", "name": "example_pipeline"}取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].category | string | 実際に必須の非空カテゴリで、たとえば logging/rum など、有効なテンプレートカテゴリを指定します。この階層には全量の列挙検証はありません。 例: logging取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].name | string | 実際のテンプレート名で、非空を推奨します。使用できるのは英数字・中国語・アンダースコア・ハイフンのみで、その他の文字はフィールド診断になります。現在 name 欠落のチェックは不完全で、データベースに到達して 500 になる可能性があります。 例: example_pipeline取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].content | string | 実際に必須の非空 Base64 UTF-8 スクリプトです。まず実際の Pipeline 構文で検証してからエンコードしてください。本 API ではデコードのみを検証し、実行/コンパイルは行いません。 例: YWRkX2tleSgiZXhhbXBsZSIsICJ2YWx1ZSIp取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].testData | string | 実際に必須の非空 Base64 UTF-8 テキストです。デコード後は JSON オブジェクトまたは配列である必要があります。配列は test data 1 などの名前付きマッピングに変換されます。空文字列/JSON 以外/スカラーはフィールド診断を引き起こします。新規追加時は保存されますが、上書き分岐では現在、新しい値を永続化されない test_data 属性に書き込み、testData 列には書き込みません。そのため古いテストデータが残る可能性があり、インポート診断の成功だけでテストデータが置き換わったと断言することはできません。 例: eyJzYW1wbGUiOnsibWVzc2FnZSI6ImV4YW1wbGUifX0=取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].source | array | 任意指定の source 関連の完全な配列で、重複は除去されます。上書き時はターゲットリストでリセットされ、余分な旧 source 関係は削除されます。省略/null/[] は source をクリアし、元の関連を保持しません。 例: ["example-source"]取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].source[*] | string | 単一の実際の Pipeline source 値で、収集設定/既存テンプレートから取得します。テンプレート UUID は記入しません。 例: example-source取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].extend | json | 任意指定の追加オブジェクトで、デフォルトは {} です。category=rum の場合は extend.appID が強制的に [] に設定され、元のアプリケーションバインドは保持されません。 例: {}取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].extend.appID | array | RUM 専用のアプリケーションバインドはこのインポートで強制的にクリアされるため、これを使ってワークスペースのアプリケーションバインドをコピーすることはできません。 例: []取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].type | string | GET がこのフィールドを返す場合がありますが、現在のインポートでは無視されます。新規テンプレートの実行型はデフォルトで空、上書き時は元の type を保持し、これによって local/central を変更することはありません。 例: local取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].asDefault | boolean | GET が返す場合がありますが、インポートでは無視されます。新規追加時はデフォルト 0、上書き時は旧値を保持します。 例: false取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].enableByLogBackup | boolean | GET が返す場合がありますが、インポートでは無視されます。新規追加時はデフォルト 0、上書き時は旧値を保持します。 例: false取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].isDisable | boolean | GET が返す場合がありますが、インポートでは無視されるため、本インポートで状態を切り替えることはできません。 例: false取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].pipelines[*].dataType | string | GET が返す場合がありますが、インポートでは無視されます。新規追加時はデフォルト line_protocol、上書き時は旧値を保持します。 例: line_protocol取得・記入方法: テンプレート詳細の同じ型の元のオブジェクトからコピーし、対応する分岐の説明に従って記入します。 |
|
| jsonContents[*].dashboardType | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。ワークスペースインポートでは省略時に CUSTOM に再設定され、旧 type は保持されません。CUSTOM のまま維持することを推奨します。main.type はこのフィールドではありません。 例: CUSTOM取得・記入方法: 有効なエクスポートテンプレートの型を保持します。 |
|
| jsonContents[*].dashboardExtend | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。ワークスペースインポートでは extend 全体を上書きし、省略時はデフォルト {} となるため、増分マージと誤解してはいけません。動的キーはエクスポート形式どおりに保持されます。 例: {}取得・記入方法: エクスポートテンプレート内の完全なダッシュボード拡張設定をコピーします。 |
|
| jsonContents[*].dashboardMapping | array | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。ワークスペースインポートでは mapping 全体を上書きし、省略時はデフォルト [] となります。各項目の動的 JSON は有効なエクスポート形式どおりに保持され、本パスでは業務構造を補完しません。 例: []取得・記入方法: エクスポートされたビュー変数フィールドマッピング配列をコピーします。 |
|
| jsonContents[*].dashboardMapping[*] | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。単一の完全なマッピングオブジェクトです。古い空のテーブルヘッダーからマッピングキーを推測して作成しないでください。 例: {}取得・記入方法: ターゲットテンプレート内の単一の実際のマッピング設定をコピーします。 |
|
| jsonContents[*].iconSet.url | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。任意指定のアイコン URL で、表示するかどうかはクライアント設定に依存します。他ブランドの固定リソースドメインを使用しないでください。 例: https://example.com/icon.png取得・記入方法: 自身がアクセス可能なアイコンリソースからアドレスを取得するか、元の値を保持します。 |
|
| jsonContents[*].iconSet.icon | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。任意指定の小アイコン設定値で、実際の構造は元のエクスポートに従います。 例: chart取得・記入方法: コンソールからエクスポートされたアイコン識別子/設定を保持します。 |
|
| jsonContents[*].dashboardBindSet | array | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。非空の真値がある場合にのみ置き換えます。省略/[] は旧バインディングを保持し、クリアではありません。 例: []取得・記入方法: ターゲットの有効なエクスポートテンプレートから完全なバインディング設定を保持します。 |
|
| jsonContents[*].dashboardBindSet[*] | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。元のバインディング設定の動的構造どおりに保存します。本エントリポイントはリソースの帰属を完全には検証しません。 例: {}取得・記入方法: 有効なエクスポートの1件のバインディングオブジェクトをコピーします。 |
|
| jsonContents[*].tags | array | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。node ワークスペースのダッシュボードでは名前でタグ関連をリセットし、非空の tags を優先的に使用します。省略/[] の場合は tagInfo を試み、どちらもなければクリアします。同名の scene/all 以外のタグはインポートコンテキストでスキップされますが、旧い関連がクリアされる可能性は残ります。配列レスポンスには skippedTags の集計は提供されません。userViewer の実際の inner 分岐はこれらのシーンタグ更新を通りません。 例: ["production"]取得・記入方法: ターゲットワークスペースに既存の scene/all タグ名、または必要な業務タグから選択します。先にスコープを確認してください。 |
|
| jsonContents[*].tags[*] | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。単一のタグ名で、最大 128 文字です。新しい名前はターゲットワークスペースで scene タグとして作成できます。 例: production取得・記入方法: 対応するタグの name をコピーし、tag_UUID は使用しません。 |
|
| jsonContents[*].tagInfo | array | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。tags に非空値がない場合にのみ、各項目の name でタグを選択します。意味は tags と同じです。追加ではなく、tagInfo.uuid でクロスワークスペースのタグを指定することはできません。 例: [{"name": "production"}]取得・記入方法: 互換性のため、エクスポート形式に既存の tagInfo がある場合は保持します。 |
|
| jsonContents[*].tagInfo[*] | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。name のみを読み取り、その他のクライアント表示フィールドは関連を決定しません。 例: {"name": "production"}取得・記入方法: 有効なエクスポートのタグ情報からコピーします。 |
|
| jsonContents[*].tagInfo[*].name | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。単一のタグ名。 例: production取得・記入方法: ターゲットに既存/新規の業務タグ名から取得します。 |
|
| jsonContents[*].main.groups[*] | string または object | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。文字列はグループ名です。オブジェクトの場合は name/extend を読み取り、name が空のオブジェクトは無視されます。グループ名は最大 256 文字です。 例: {"name": "业务指标", "extend": {}}取得・記入方法: エクスポートされたグループ構造からコピーします。 |
|
| jsonContents[*].main.groups[*].name | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。オブジェクト形式のグループ名で、空にできません。グラフは同名の group でグループ化されます。 例: 业务指标取得・記入方法: グループ名を自分で定義するか、既存のエクスポート名をコピーします。 |
|
| jsonContents[*].main.groups[*].extend | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。任意指定のグループ拡張オブジェクトで、省略時は {} です。 例: {}取得・記入方法: グループの折りたたみなど、エクスポートされた設定を保持します。 |
|
| jsonContents[*].main.charts[*] | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。グラフオブジェクトで、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}}取得・記入方法: コンソールで検証済みのグラフのエクスポートオブジェクトからコピーし、実際のクエリ文を修正します。 |
|
| jsonContents[*].main.charts[*].name | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。省略または空値の場合は空のタイトルとなり、最大 256 文字です。 例: CPU空闲取得・記入方法: グラフの表示名を記入します。 |
|
| jsonContents[*].main.charts[*].type | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。デフォルトは line で、保存時に小文字になります。現在は sequence のみではなく、サポートされる型はコンソールのエクスポートに従います。 例: line取得・記入方法: 有効なエクスポートのグラフ型(line や combine など)を保持します。 |
|
| jsonContents[*].main.charts[*].uuid | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。指定しても破棄され、新しいグラフ ID が再作成されます。旧いグラフの関連を保持するために使用することはできません。 例: chrt_example取得・記入方法: 旧いエクスポートに含まれている場合がありますが、通常の呼び出しでは記入不要です。 |
|
| jsonContents[*].main.charts[*].group | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。文字列のグループ名、{name: グループ名}、または null を指定できます。対応するグループがない場合は default に分類されます。オブジェクトは name で解析されます。 例: {"name": "业务指标"}取得・記入方法: 今回の main.groups 内の名前と完全に一致させます。 |
|
| jsonContents[*].main.charts[*].group.name | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。グループ名。null の場合はグループ化しないことを表します。 例: 业务指标取得・記入方法: 今回の main.groups 内の name を参照します。 |
|
| jsonContents[*].main.charts[*].pos | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。レイアウトオブジェクトで、省略時は {} です。クライアントのレイアウト単位で解釈され、サーバーはそのまま保存します。旧説明の string を強制的な数値契約として扱いません。 例: {"x": 0, "y": 0, "w": 12, "h": 6}取得・記入方法: エクスポートされたレイアウトからコピーします。 |
|
| jsonContents[*].main.charts[*].pos.x | number | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。横位置(クライアントのグリッド単位)。 例: 0取得・記入方法: エクスポートされたグリッドの横座標をコピーします。 |
|
| jsonContents[*].main.charts[*].pos.y | number | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。縦位置。 例: 0取得・記入方法: エクスポートされたグリッドの縦座標をコピーします。 |
|
| jsonContents[*].main.charts[*].pos.w | number | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。幅。 例: 12取得・記入方法: エクスポートされたグリッドの幅をコピーします。 |
|
| jsonContents[*].main.charts[*].pos.h | number | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。高さ。 例: 6取得・記入方法: エクスポートされたグリッドの高さをコピーします。 |
|
| jsonContents[*].main.charts[*].pos.i | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。任意指定のクライアントレイアウトマーカーで、新しいグラフの実際の UUID としては使用されません。 例: chart-position取得・記入方法: 元のエクスポートの表示マーカー(ある場合)を保持します。 |
|
| jsonContents[*].main.charts[*].extend | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。グラフ全体の拡張オブジェクトで、省略時は {} です。ネストされたキーはグラフ型によって動的に変わり、現在は元の JSON のまま保存され、必要なクライアント設定が自動補完されることはありません。 例: {}取得・記入方法: 有効なエクスポートの settings/style などグラフ拡張設定を完全に保持します。 |
|
| jsonContents[*].main.charts[*].queries | array | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。通常のグラフではクエリオブジェクトの配列です。combine の外側はサブグラフオブジェクトで、各サブグラフは独自の queries 配列を持ちます。配列を文字列/単一オブジェクトで代替してはいけません。 例: [{"qtype": "dql", "query": {"q": "M::`cpu`:(`usage_idle`)"}}]取得・記入方法: 検証済みのグラフのエクスポートからクエリ構造をコピーします。 |
|
| jsonContents[*].main.charts[*].queries[*] | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。通常のクエリオブジェクトは qtype/query を読み取り、追加の表示キーは保持されます。combine のサブグラフ uuid は最初の main とその他の一意な内部 ID に正規化され、ネストされた queries は再帰的に検証されます。 例: {"qtype": "dql", "query": {"q": "M::`cpu`:(`usage_idle`)"}}取得・記入方法: 通常はエクスポートされたクエリオブジェクトを使用し、combine ではエクスポートされた完全なサブグラフオブジェクトを使用します。 |
|
| jsonContents[*].main.charts[*].queries[*].qtype | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。通常のクエリ型で、本インポート呼び出しではクエリを実行せず、業務データの存在も検証しません。 例: dql取得・記入方法: dql/promql など実際のクエリ構文型を使用します。 |
|
| jsonContents[*].main.charts[*].queries[*].query | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。通常のクエリパラメータの動的オブジェクトです。query キーがある場合はオブジェクトである必要があり、時間/変数/データソースのフィールドは有効なエクスポートどおりに保持されます。本エントリポイントは保存のみで、これによってデータクエリを同期実行することはありません。 例: {"q": "M::`cpu`:(`usage_idle`)"}取得・記入方法: 有効なエクスポートのクエリオブジェクトをコピーします。実際のフィールドは同期クエリパラメータを参照してください。 |
|
| jsonContents[*].main.charts[*].queries[*].query.q | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。通常のクエリ文で、テンプレート変数を含めることができます。クロスワークスペースのテンプレートでは、実際のデータセット/フィールド/変数の可用性を確認する必要があります。 例: M::`cpu`:(`usage_idle`)取得・記入方法: ターゲットワークスペースのクエリツールで検証したうえで DQL/PromQL をコピーします。 |
|
| jsonContents[*].main.charts[*].queries[*].query.outerDatasourceInfo | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。マネージド参照は configMd5 によってターゲットワークスペースで uuid を再バインドします。一致するものが見つからない場合は旧ワークスペースの uuid を削除しますが摘要は保持し、データソースは作成しません。funcServerId などの関数参照はターゲットワークスペースの設定を確認する必要があり、本パスは完全なリソース移行ではありません。 例: {"configMd5": "<exported-config-digest>"}取得・記入方法: マネージド外部データソース参照ではエクスポートされた configMd5 を保持し、事前に各ターゲットワークスペースで同一内容のデータソースを設定しておきます。 |
|
| jsonContents[*].main.charts[*].queries[*].query.outerDatasourceInfo.configMd5 | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。ターゲットデータソース設定の一致摘要。 例: <exported-config-digest>取得・記入方法: 有効なエクスポート値をそのまま使用し、業務摘要を手動で生成しないでください。 |
|
| jsonContents[*].main.charts[*].queries[*].queries | array | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。結合サブグラフ階層でのみ使用され、内部構造は通常の queries と同じで再帰可能です。通常の query オブジェクトとして扱わないでください。 例: []取得・記入方法: combine グラフでは有効なエクスポートのサブグラフクエリ配列を保持します。 |
|
| jsonContents[*].main.vars[*] | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。変数オブジェクトで、name/code/type は strip され、type は大文字になります。変数型ごとに異なる definition/extend の動的構造はコンソールの有効なエクスポートを保持する必要があり、サーバーはここでフロントエンドの意味論を全面的には検証しません。 例: {"name": "主机", "code": "host", "type": "QUERY", "definition": {}}取得・記入方法: ターゲットで利用可能なテンプレートから変数オブジェクトをエクスポートし、名前から definition の形式を推測しないでください。 |
|
| jsonContents[*].main.vars[*].name | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。表示名で、デフォルトは空、前後の空白は除去されます。 例: 主机取得・記入方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。 |
|
| jsonContents[*].main.vars[*].code | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。変数コードで、デフォルトは空、前後の空白は除去されます。クエリ内の変数参照と一致する必要があります。 例: host取得・記入方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。 |
|
| jsonContents[*].main.vars[*].type | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。変数型で、デフォルトは空の後で大文字に変換されます。コンソールの有効なエクスポート型を使用してください。 例: QUERY取得・記入方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。 |
|
| jsonContents[*].main.vars[*].definition | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。変数型に応じてエクスポート定義を完全にコピーします。デフォルトは {} です。 例: {}取得・記入方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。 |
|
| jsonContents[*].main.vars[*].datasource | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。任意指定のデータソース型で、デフォルトは空文字列、元のエクスポートどおりに保持します。 例: metric取得・記入方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。 |
|
| jsonContents[*].main.vars[*].valueSort | string | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。任意指定の値ソートで、デフォルトは空文字列です。 例: asc取得・記入方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。 |
|
| jsonContents[*].main.vars[*].hide | integer | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。表示/非表示の切り替えで、デフォルトは 0 です。 例: 0取得・記入方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。 |
|
| jsonContents[*].main.vars[*].isHiddenAsterisk | integer | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。アスタリスク非表示オプションの切り替えで、デフォルトは 0 です。 例: 0取得・記入方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。 |
|
| jsonContents[*].main.vars[*].multiple | boolean | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。複数選択かどうかで、デフォルトは true です。 例: true取得・記入方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。 |
|
| jsonContents[*].main.vars[*].includeStar | boolean | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。アスタリスクオプションを含めるかどうかで、デフォルトは true です。 例: true取得・記入方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。 |
|
| jsonContents[*].main.vars[*].extend | json | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。変数拡張オブジェクトで、デフォルトは {}、元のエクスポートどおりに完全コピーします。 例: {}取得・記入方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。 |
|
| jsonContents[*].main.vars[*].seq | integer | dashboard テンプレートの元の設定キーです。本ライブラリのインポートでは主にそのまま保存され、実際の適用ルールはダッシュボード識別子インポートを参照してください。インポート時は配列位置で再計算され、この値で最終順序を制御することはできません。 例: 0取得・記入方法: 有効なエクスポートの変数オブジェクトからコピーし、本テンプレートのクエリ参照と照合します。 |
|
| isCover | boolean | 任意指定で、省略/null は false です。上書きしない場合、既存のカスタム同名競合が本バッチを阻止します。true は一致するカスタムテンプレートの上書きを許可しますが、バッチ内の重複名/識別子競合/フィールドエラーを回避するものではありません。上書きは完全な meta またはサポートされるスクリプト設定の置き換えであり、JSON のマージではありません。Pipeline.testData の上書きには現在マッピングの制限があるため、該当フィールドを参照してください。 null 許可: True 例: false取得・記入方法: 通常の初回インポートでは false、同種同言語のターゲットを上書きできると確認した後に true を使用します。 |
|
| jsonContents | array | Y | 必須のオブジェクト配列です。空の [] は書き込まれず、HTTP200 の index=-1/err_fields=[jsonContents] が返されます。各項目は JSON オブジェクトである必要があり、シリアライズされた文字列は不可です。固定専用エクスプローラーは現在最初の項目のみを処理し、残りは無視されます。その他の分岐は下表のとおり処理します。 null 許可: False 例: [{"title": "业务指标", "identifier": "business-dashboard", "main": {"groups": [], "charts": [], "vars": []}}]取得・記入方法: テンプレート詳細 の content から type に一致する完全なオブジェクトを取得して配列に入れます。Pipeline は pipelines ラッパーを保持します。 |
| language | string | Y | 必須と宣言されており、zh、en、zh-hant、id、ja、ko、null または空文字列を指定できます。null/空文字列は現在 zh として扱われます。カスタム名のマッチングは通常この言語の完全一致で、Pipeline は共通の空言語にもマッチします。常に明確な非空の言語を渡すことを推奨し、表示名で代替することはできません。 空文字列の許可: True null 許可: True 選択可能な値: ['zh', 'en', 'zh-hant', 'id', 'ja', 'ko'] 例: zh取得・記入方法: 作成/上書きする正確な言語を選択します。 |
| summary | string | 任意指定で、monitor は meta.summary に書き込みます。その他の分岐では本トップレベルフィールドを無視し、元のオブジェクトのメタデータを使用します。省略時はデフォルトで空です。 null 許可: False 例: 业务异常检测模板取得・記入方法: monitor の場合に検出ライブラリの概要を指定します。 |
|
| title | string | monitor では実際に必須で非空を推奨し、子内容の title から自動取得しません。その他のインポート分岐では jsonContents 項目の title または main.source を使用し、本トップレベルフィールドは無視されます。省略時はデフォルトで空です。 null 許可: False 例: 业务监控检测库取得・記入方法: monitor の場合のみ新しい検出ライブラリ名を記入し、リストで重複名を確認します。 |
|
| type | string | Y | 必須の単一型で、1つのバッチで異なるカテゴリを混在インポートすることはできません。dashboard/monitor/pipeline には専用構造があります。object/resource-catalog および固定エクスプローラーは下表のルールに従います。security/customer-explorer などのその他の型は title で完全な meta を保存します。 null 許可: False 選択可能な値: ['dashboard', 'monitor', 'security', 'customer-explorer', 'pipeline', 'object-explorer', 'resource-catalog-explorer', 'ci-explorer', 'rum-explorer', 'tracing-default-explorer', 'cloud-test-explorer', 'tracing-profile-explorer', 'tracing-error-track-explorer', 'logging-default-explorer', 'keyevent-default-explorer', 'security-check-explorer', 'network-explorer', 'tracing-service-explorer', 'logging-error-track-explorer', 'cloud-billing-explorer'] 例: dashboard取得・記入方法: テンプレートの用途から本リクエストで宣言する型の列挙値を選択します。GET の内容構造と一致させてください。 |
パラメータ補足説明¶
型ごとの内容の構築方法¶
汎用 title 型(dashboard、security、customer-explorer など):各項目は自身の title と完全な元の meta を使用します。dashboard はさらに identifier の競合をチェックしますが、すべてのグラフクエリを事前チェックしません。monitor はすべての項目の checkers をトップレベル title で定義された1つの検出ライブラリにマージします。各 jsonScript.title/type を確認する必要があります。Pipeline は pipelines 配列でラップし、スクリプト/テストデータは UTF-8 Base64 で指定します。平文をそのまま content に入れることはできません。
固定専用エクスプローラーは jsonContents[0] のみを処理し、後続の項目は無視されます。返されていない index からインポート済みと推測しないでください。object-explorer と resource-catalog-explorer は項目ごとにインポートできますが、それぞれ最初の main 項目から定義済みの object ソースまたは実際の custom_object ソースを選択します。
| インポート/フィルター type | 保存 fileName | 推奨 class | 推奨 source.key |
|---|---|---|---|
| ci-explorer | ci | gitlab | gitlab_pipeline |
| rum-explorer | rum | rum | session |
| tracing-default-explorer | tracing__default | tracing | tracing |
| cloud-test-explorer | cloud_test | dial_testing | http_dial_testing |
| tracing-profile-explorer | tracing__profile | profiling | tracing |
| tracing-error-track-explorer | tracing__error_track | error_track | tracing |
| logging-default-explorer | logging__default | logging | logging__default |
| keyevent-default-explorer | keyevent__default | keyevent | monitor |
| security-check-explorer | security_check | security | security_check |
| network-explorer | network | network | netflow |
| tracing-service-explorer | tracing__service | tracing | tracing |
| logging-error-track-explorer | logging__error_track | error_track | logging__error_track |
| cloud-billing-explorer | cloud_billing | billing | cloud_billing |
| object ソースキー | 固定 fileName | 固定表示名 |
|---|---|---|
| kubernetes_jobs | object__job | Jobs |
| kubernetes_nodes | object__node | Nodes |
| kubernetes_cron_jobs | object__cron_job | Cron Jobs |
| kubernetes_deployments | object__deployment | Deployments |
| docker_containers | object__container | Containers |
| host | object__host | host |
| host_processes | object__process | host_processes |
| kubernetes_dfpv | object__dfpv | Persistent Volumes |
| kubernetes_statefulsets | object__statefulset | Statefulsets |
| kubernetes_clusters | object__cluster | Clusters |
| kubernetes_daemonset | object__daemonset | Daemonset |
| others | object__others | others |
| kubelet_pod | object__pod | Pods |
| kubernetes_replica_sets | object__replica_set | Replica Sets |
| kubernetes_services | object__service | Services |
| database_mysql | object__mysql | MySQL |
| kubernetes_persistentvolumeclaims | object__pvc | Persistent Volume Claims |
Base64 構築例¶
import base64
import json
script = 'add_key("example", "value")'
content = base64.b64encode(script.encode("utf-8")).decode("ascii")
test_data = base64.b64encode(json.dumps({"sample": {"message": "example"}}, ensure_ascii=False).encode("utf-8")).decode("ascii")
print(content, test_data)
リクエスト例¶
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/sys_template/custom/import'
query = {}
data = {'type': 'dashboard', 'language': 'zh', 'isCover': False, 'jsonContents': [{'title': '业务指标', 'identifier': 'business-dashboard', '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 は本ページの分岐によりオブジェクト/配列/null/true となり、OpenAPI declaration に自動追加されません。リストのページネーションは content.pageInfo にあります。
| フィールド | 型 | 説明 |
|---|---|---|
| content | オブジェクト配列 | インポート診断の配列です。HTTP200/success=true はコミット済みを意味しません。ブロックフィールド/競合が1つでも存在する場合、その分岐はバッチ全体が書き込まれません。インポート後の UUID は返されません。 |
| content[].index | integer | jsonContents 外側のゼロ始まりの連番で、トップレベル/monitor の事前チェックエラーでは -1 になることがあります。Pipeline の複数のサブ項目は同じ index を持つことがあり、子位置は err_fields のパスで判断します。 |
| content[].name | string または null | テンプレート名またはソースキーです。固定専用エクスプローラーの診断では name が空になることがあります。 |
| content[].err_fields | 文字列配列 | 本項目のフィールドエラーパスです。非空の場合、その分岐はバッチ全体が書き込まれません。 |
| content[].err_fields[] | string | 例:name、main.checkers、[0].pipelines[0].content。 |
| content[].is_exists_name | boolean | 既存のカスタム同名/同一ファイルの競合です。上書きに成功すると false に正規化されます。 |
| content[].import_exists_name | boolean | 本リクエスト内の重複名/同一ファイルターゲットで、true はバッチ全体を阻止します。 |
| content[].is_exists_identify | boolean | dashboard 専用:別の既存テンプレートの identifier との競合で、上書きでも回避できません。 |
| content[].identifier | string | dashboard 専用の本項目の identifier。 |
| content[].import_exists_identity_id | boolean | dashboard 専用で、本バッチ内の identifier 重複を表します。 |
{
"code": 200,
"content": [
{
"index": 0,
"name": "业务指标",
"err_fields": [],
"is_exists_name": false,
"is_exists_identify": false,
"identifier": "business-dashboard",
"import_exists_name": false,
"import_exists_identity_id": false
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
HTTP200 の業務検証失敗により、バッチ全体がインポートされない例:
{
"code": 200,
"content": [
{
"index": 0,
"name": "已有模板",
"err_fields": [],
"is_exists_name": true,
"import_exists_name": false
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
空の jsonContents の例:
{
"code": 200,
"content": [
{
"index": -1,
"name": "",
"err_fields": [
"jsonContents"
],
"is_exists_name": false
}
],
"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 オブジェクトを送信してください。 |
| 500 | ft.InternalServerError | jsonContents 要素/動的フィールドの型エラー、Base64 以外の未検証構造、データベースの保存/削除異常 | 内部エラー | まずテンプレートリストと詳細で現在の状態を確認してから再試行してください。HTTP200 診断は 500 とは異なり、エラーでは項目ごとの書き込み UUID は提供されません。traceId を保持し、むやみに上書きを繰り返さないでください。 |