デフォルトの DevOps コンフィグ エクスポーター

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：9分

    • DevOps コンフィグ エクスポーターコンテンツパックには、さらなる展開およびプロビジョニングアクティビティの入力として使用できる、データのデフォルトのDevOps コンフィグエクスポーターのセットが含まれています。

    重要:
    Washington DC リリース以降、DevOps コンフィグ は将来の廃止に備えて準備されます。これは非表示になり、新しいインスタンスにはインストールされなくなりますが、引き続きサポートされます。詳細については、Now Support ナレッジベースの「Deprecation Process (廃止プロセス) [KB0867184]」の記事を参照してください。

    DevOps コンフィグ エクスポーターを使用すると、他のツールが展開可能なスナップショットのデータを使用できます。

    注:
    デフォルトのエクスポーターは変更できません。ただし、エクスポーターのコピーを作成して、そのコピーをカスタマイズすることはできます。
    これらのエクスポーターは、 DevOps コンフィグ エクスポーターコンテンツパックに含まれています。
    • returnAllData-now
    • returnAllData_noVars-now
    • returnDataforNodeName-now
    • returnDataForNodeNames-now
    • returnDataForPath-now
    • returnNodeListForLevel-now
    • returnNodeListForPath-now
    • returnValueForKeyAtNodeName-now
    • returnValueForKeyPath-now
    • returnValueForUniqueKeyName-now

    すべてのデータを返す (returnAllData-now)

    var システムフォルダーを含む、フィルタリングや変更を行わずにスナップショットの完全なコンテンツを返します。
    注:
    アプリケーション/展開可能項目がアクティブステータス (削除済み) でない場合、エクスポーターは失敗します。
    引数
    • appName:アプリケーション名
    • deployableName:展開可能項目の名前
    • requestedFormat:要求された形式 (json/yaml/xml/ini/raw)
    特殊ロジック
    なし。
    エラー処理
    なし。

    変数を除くすべてのデータを返す (returnAllData_noVars-now)

    展開可能項目の名前と変数を除く、展開可能項目のすべての構成データを返します。

    応答には以下は含まれません。
    • 展開可能レベルの vars フォルダー
    • vars フォルダーに保存されます
    • 応答のルートレベルの展開可能項目名
    注:
    このエクスポーターは、削除されたアプリケーション/展開可能項目に対しては機能しません。
    引数
    引数 (コマンド ラインで指定するか、実行モードで対話的に入力できます)。
    • appName:アプリケーション名
    • deployableName:展開可能項目の名前
    • requestedFormat:要求された形式 (json/yaml/xml/ini/raw)
    特殊ロジック
    なし。
    エラー処理
    なし。

    ノード名のデータを返す (returnDataforNodeName-now)

    引数として指定されたノード名のスナップショットデータのサブセットを返します。引数の値は文字列テキストとして渡す必要があります。

    引数
    • appName:アプリケーション名
    • deployableName:展開可能項目の名前
    • requestedFormat:要求された形式 (json/yaml/xml/ini/raw)
    • nodeName - ノード名 (文字列、引用符で囲む)
    特殊ロジック
    • nodeName が空の場合、すべてのデータが返されます。
    エラー処理
    • nodeName が一意でない場合は、 nodeName の複数のインスタンスが見つかりました。
    • nodeName が見つからない場合は、 ノードが見つかりません:<nodeName>。

    ノードのリストのデータを返す (returnDataForNodeNames-now)

    ノードのリストのスナップショットから完全なデータを返します。ノード名のデータを返すと同じですが、指定されたノード名のリスト (子ノードを含む) の構成データを含むネストされた JSON を返します。

    引数
    • appName:アプリケーション名
    • deployableName:展開可能項目の名前
    • requestedFormat:要求された形式 (json/yaml/xml/ini/raw)
    • nodeNames:ノード名 (文字列、引用符、カンマ区切り)
    特殊ロジック
    nodeNamesList が空の場合は、すべての構成データを返します。
    エラー処理
    なし。
    応答の詳細
    {"node1":{"contentKey":"contentValue"},"node2":{ "error":"nodeName が見つかりません"}}。
    エラー処理
    • nodeName が一意でない場合、エクスポーターは、その特定の nodeName に対して「nodeName の複数のインスタンスが見つかりました」というエラー応答を返します。他の nodeName にはデータが含まれています
    • nodeName が見つからない場合は、そのノードのエラーメッセージが含まれている必要があります

    パスのデータを返す (returnDataForPath-now)

    スナップショット内の指定されたノードパスのすべての構成データを返します。

    引数
    • appName:アプリケーション名
    • deployableName:展開可能項目の名前
    • requestedFormat:要求された形式 (json/yaml/xml/ini/raw)
    • nodePath - ノードパス (文字列、引用符で囲む)
    特殊ロジック
    nodePath が空の場合は、コンテンツ全体を返します (すべての構成データと同様)。
    エラー処理
    nodePath が見つからない場合は、見つからなかった最後のノード名が 示されます: path not found: <nodeName>。

    水準のノードリストを返す (returnNodeListForLevel-now)

    スナップショット内の指定されたレベル (深度) のルートノードの子であるノードの名前のリストを返します。たとえば、レベル 1 はルートノードの直接の子、レベル 2 は孫などです。

    引数
    • appName:アプリケーション名
    • deployableName:展開可能項目の名前
    • requestedFormat:要求された形式 (json/yaml/xml/ini/raw)
    • ExcludeVarsNode [true|false] - 変数ノードを結果から除外します (true または false、デフォルトは true)
    • nodeLevel - ノードのレベル (整数、デフォルトは 0)
    特殊ロジック
    レベルが指定されていない場合、エクスポーターはレベル 0 の値 (デプロイ可能なルートノード名など) を返します。
    エラー処理
    なし。
    応答の詳細
    ["ノード1、 "ノード2"、 "ノード3"]

    パスのノードリストを返す (returnNodeListForPath-now)

    スナップショット内の指定されたノードパスのノードのリストを返します (サブノードは考慮しません)。

    引数
    • appName:アプリケーション名
    • deployableName:展開可能項目の名前
    • requestedFormat:要求された形式 (json/yaml/xml/ini/raw)
    • ExcludeVarsNode [true|false] - 変数ノードを結果から除外します (true または false、デフォルトは true)
    • nodePath - pathSeparator で区切られたノードのリストが続くパス (文字列、引用符で囲む)
    • pathSeparator - nodePaths のリストを区切る文字 (文字列、デフォルトは ',')
    特殊ロジック
    なし。
    エラー処理
    なし。
    応答の詳細
    ["ノード1、 "ノード2"、 "ノード3"]

    ノード内のキーの戻り値 (returnValueForKeyAtNodeName-now)

    スナップショット内のノードの一部である特定のキーの値を返します。キーは、ノードに直接定義することも、データモデルの下位でノードの子の 1 つに定義することもできます。

    このエクスポーターと 一意の keyName のエクスポート値 の違いは、キー名がノードのサブツリー内でのみ一意である必要があることです。

    キー/ノードの組み合わせは、スナップショット内で一意であることが期待されます。キー/ノードの組み合わせが複数回見つかった場合は、エラーが発生します。

    引数
    • appName:アプリケーション名
    • deployableName:展開可能項目の名前
    • requestedFormat:要求された形式 (json/yaml/xml/ini/raw)
    • keyName:キー名(文字列、引用符で囲む)
    • nodeName - ノード名 (文字列、引用符で囲む)
    特殊ロジック
    なし。
    エラー処理
    keyName、nodeName、の組み合わせが見つからない場合は、空の応答が返されます。

    keyPath の戻り値 (returnValueForKeyPath-now)

    特定のパス内の特定のキーの値を返します。

    引数
    • appName:アプリケーション名
    • deployableName:展開可能項目の名前
    • requestedFormat:要求された形式 (json/yaml/xml/ini/raw)
    • keyPath:pathSeparator (文字列、引用符で囲まれた) で区切られたキー名の末尾を持つノード名のリスト
    • pathSeparator - keyPaths のリストを区切る文字 (文字列、デフォルトは ',')
    特殊ロジック
    なし。
    エラー処理
    • keyPath が指定されていない場合、 keyPath 引数は指定されません。
    • keyPath が見つからない場合は、最後のノード名が見つからない 、パスが見つからないことを示します: <path>/<nodeName>。
    • keyPath が見つかり、ノード (キーではない) である場合、 指定された keyPath はノードであり、キーではありません。

    一意の keyName の戻り値 (returnValueForUniqueKeyName-now)

    スナップショット内の名前に基づいて、特定のキーの値を返します。ノード内のキーのエクスポート値とは異なり、キーはスナップショットデータモデル全体で一意であることが期待されます。複数のキーがサポートされています。
    注:
    このエクスポーターでは、xml および ini 形式はサポートされていません。
    引数
    • appName:アプリケーション名
    • deployableName:展開可能項目の名前
    • requestedFormat:要求された形式 (json/yaml/raw)
    • keyName - キー名 (データ配列)
    特殊ロジック
    キーがスナップショットに複数回存在する場合、エクスポーターは最初に見つかった値を返します (エラーを返します)。
    エラー処理
    • keyName が指定されていない場合、 keyName 引数は指定されません。
    • キーが見つからない場合は、 キーが見つかりません:<keyName>。