管理Webサービスにおける操作のリスト

管理Webサービスには、複数のデータ・ドメイン・クラスタをホストするEndeca Serverクラスタのコンテキストで、新規データ・ドメインの作成と既存データ・ドメインの管理のための操作があります。

操作の説明

管理Webサービスにより、新規データ・ドメインの作成や既存データ・ドメインの管理を行うリクエストを発行できます。

管理Webサービスを使用する前に、Endeca ServerノードをWebLogic Serverコンテナにデプロイし、クラスタWebサービスを使用して、データ・ドメイン・プロファイルを作成します。

管理Webサービスで作成するデータ・ドメインごとに次の特性があります。
  • ノード自体がEndeca Serverクラスタに属するEndeca Serverノードのサブセット上にあります。
  • 既存データ・ドメイン・プロファイルと関連付けされます。作成すると、ドメイン・プロファイルにより、データ・ドメイン・クラスタごとに利用できるリソースが決まります。(データ・ドメインの特性は作成後に変更できます。)

リクエスト

管理Webサービスの入力は、そのリクエストの要素によって異なります。次に例を示します。
  • 新規データ・ドメインを作成するには、createDataDomain要素を使用して、その名前とデータ・ドメイン・プロファイル名を指定します。
  • 存在している索引ファイルを使用して新規データ・ドメインを作成するには、importDataDomain要素を使用して、その名前、データ・ドメイン・プロファイル名、および以前にエクスポートした索引ファイルのラベルを指定します。

他の操作については、このトピックにおいて操作のリストで説明します。

レスポンス

リクエストの成功に応じて、管理Webサービスでは次を返します。
  • 問題がなくレスポンスが成功すると、空のレスポンス要素が返されます(listDataDomainslistDataDomainProfilesの操作は例外で、情報が返されます)。
  • 指定された名前のデータ・ドメインが存在している、データ・ドメイン・プロファイルがEndeca Serverクラスタで定義されていない、Endeca Serverクラスタにはリクエストの処理で十分なリソースがない、Endeca Serverクラスタにおいて現在のハードウェア・リソースを超える特性のデータ・ドメイン・プロファイルが構成されているなど、インスタンスでEndeca Serverエラーを示すSOAPフォルト。

操作のリスト

管理Webサービスにより、次の操作ができます。それらの操作はリクエストにある要素で示されます。
リクエスト要素 説明
allocateBulkLoadPort 指定されたnameのデータ・ドメイン用に、リーダー・ノードのホスト名とバルク・ロード・インタフェースで使用するポートを返します。

これは読取り-書込み操作です。現在のリーダー・ノードが利用できる場合、現在のDgraphリーダー・ノードを検証して、バルク・ロードで使用するポートとともにレポートします。現在のリーダー・ノードが利用できないと、新規リーダー・ノードと新規バルク・ロード用ポートを指名してレポートします。

データ・ドメインがアイドル状態である場合、この操作(endeca-cmd allocate-bulk-load-portも同等)でDgraphプロセスを再起動することにより、データ・ドメインをアクティブ化します。

createDataDomain 新規データ・ドメインをEndeca Serverクラスタで作成します。その際、その名前、データ・ドメイン・プロファイル名および(オプションで)有効化されるかどうかを指定します。値は次のとおりです。
  • nameは、データ・ドメインの名前です。
  • ddProfileNameは、使用するデータ・ドメイン・プロファイルの名前です。
  • enabled(オプション)。trueに設定されていると、データ・ドメインは有効化されます。これがデフォルトです。falseに設定されていると、データ・ドメインは無効化されます。
deleteDataDomain データ・ドメインをシステムから完全に削除します。これによって、関連付けられているリソースがすべて削除されます。これらのリソースには、このデータ・ドメインのソース・レコード、構成、ログおよび索引ファイルが含まれます。いかなる種類のバックアップも実行されません。データ・ドメインを削除すると、元に戻せません。

データ・ドメインを削除するには、そのnameをこの要素に指定します。

cloneDataDomain 指定された既存データ・ドメインをコピーすることで、新規データ・ドメインを作成します。
データ・ドメインをクローニングするには、次を指定します。
  • nameは、作成する新規データ・ドメインの名前です。
  • sourceNameは、コピー元データ・ドメインの名前です。
  • enabled(オプション)。新規データ・ドメインを有効にするかどうか。enabled値を指定しないと、新規データ・ドメインはデフォルトで有効になります。
rescaleDataDomain フォロワ・ノードの数をデータ・ドメイン・クラスタに追加することで、指定されたデータ・ドメインをサイズ変更します。データ・ドメインを再スケールするには、そのnamenumFollowers(問合せを処理するDgraphフォロワ・ノードの適切な数)を指定します。Endeca Serverクラスタに十分な数のノードがあり、データ・ドメインのサイズを変更しても対応することを確認します。この操作では、データ・ドメインへのノードの追加のみを実行できます。削除は行えません。
注意: データ・ドメインのプロファイルで、リーダー・ノードでの問合せが禁止されている(allowQueriesOnLeaderfalseに設定されている)場合、numFollowersを1よりも大きくして、1つ以上のフォロワ・ノードで問合せ処理を利用可能にする必要があります。
exportDataDomain 索引のスナップショットを取得し、内部に格納されるファイルにコピーすることで、指定されたデータ・ドメインの索引をエクスポートします。スナップショットは索引ファイルのコピーのみを表しており、データ・ドメインにおける他の特性(作成時に使用されたデータ・ドメイン・プロファイルやDgraph構成など)は取得しません。

有効化したデータ・ドメインと無効化したデータ・ドメインのどちらもエクスポートできます。

有効化されたデータ・ドメインをエクスポートすると、そのデータ・ドメインは引き続き実行されますが、索引のコピーは共有ファイル・システム上のオフライン・ディレクトリに格納されます。

データ・ドメインをエクスポートするには、次を指定します。
  • nameは、エクスポート対象の索引があるデータ・ドメインの名前です。
  • nameOfOfflineDataDomain(オプション)。エクスポートされると、このデータ・ドメインの索引に付与される名前。この名前は一意である必要があります。指定しない場合、元のデータ・ドメイン名に日付が付加されることで自動的に割り当てられます(name_MMMMM-dd-yyyy-hh-mm形式になります)。リクエストにより、エクスポートした索引で使用される名前が返されます。
    重要: nameOfOfflineDataDomainの値を追跡してください。この索引をインポートするために後で必要です。
importDataDomain 以前にエクスポートした索引ファイルを使用して、新規データ・ドメインを作成します。現在索引をエクスポートしているデータ・ドメインを以前に作成したことが、この操作の使用の前提になります。また、exportDataDomain操作で使用したnameOfOfflineDataDomainを追跡していることや、自動的に割り当てられた名前を知っていることも前提になります。
データ・ドメインをインポートするには、次を指定します。
  • nameは、以前にエクスポートしたデータ・ドメインの索引ファイルのインポート先である新規データ・ドメインの名前です。
  • nameOfOfflineDataDomainは、以前にエクスポートした索引ファイルの名前です。
  • ddProfileName(オプション)。インポートした索引ファイルで作成された新規データ・ドメインで使用する、データ・ドメイン・プロファイルの名前。
  • enabled(オプション)。新規にインポートされたデータ・ドメインを有効にする(trueに設定されている場合)かどうかを指定します。値を指定しないと、インポートしたデータ・ドメインがデフォルトで有効になります。
enableDataDomain そのnameを指定することで、データ・ドメインを有効化します。これによって、データ・ドメインのDgraphノード(プロセス)が起動します。
disableDataDomain そのnameを指定することで、データ・ドメインを無効化します。無効化されたデータ・ドメインが存在し、リソースが割り当てられますが、データ・ドメインがリクエストを処理できる前に、そのDgraphノードを停止してenableDataDomainを有効化する必要があります。
getDataDomain 指定されたnameのデータ・ドメインに関する情報を取得します。レスポンスにより、データ・ドメイン名とそのステータス(有効または無効)が返されます。
listDataDomains すべての既存データ・ドメインがリストされ、追加ステータス情報(名前、説明、データ・ドメインが有効化されているかどうか、ノードの数、問合せ処理スレッドの数、Dgraphプロセス用に指定された引数のリスト(指定されている場合)など)が含まれます。
getDataDomainStats データ・ドメインのnameを指定すると、データ・ドメインに関するランタイム統計が返されます。レスポンスには次の情報が含まれます。
  • 共有記憶域の索引レコードのサイズ(MB単位)。
  • データ・ドメインにおけるソース・レコードの数(この数からは、非データやシステム・レコードは除外されます)。
  • Dgraph起動時間、最終索引作成時間およびパスを含めた、データ・ドメインにおける実行DgraphノードごとのDgraphノード統計。統計ページは、Oracle Endecaサポート用です。
getDataDomainProfile 指定されたnameのデータ・ドメイン・プロファイルに関する情報を取得します。プロファイルの名前と説明、および他のデータ・ドメイン・プロファイル特性(ノードの数、問合せ処理スレッドの数、Dgraphプロセスに送信される引数のリストなど)が返されます。
listDataDomainProfiles Endeca Serverクラスタで構成されたデータ・ドメイン・プロファイルのセットが返されます。データ・ドメイン・プロファイルごとに、その名前、説明および他の特性(ノードの数、問合せ処理スレッドの数、Dgraphプロセスに送信される引数のリストなど)が返されます。
updateDataDomain データ・ドメインを更新して、別のデータ・ドメイン・プロファイルを使用します。
データ・ドメインを更新するには、次の項目を指定します。
  • 名前
  • 新しいデータ・ドメイン・プロファイルの名前、ddProfileName

この操作を実行する前には、データ・ドメインを無効にして、新しいデータ・ドメイン・プロファイルを作成し、この新しいプロファイルを使用してEndeca Serverがデータ・ドメインに十分なリソースを割り当てるようにしてください。この操作を実行してもデータ・ドメインは引き続き無効な状態であるため、有効にする必要があります。

warmCache カスタムのウォーミング・アップ・スクリプトを作成せずにキャッシュをウォーミング・アップするためのDgraphプロセスをリクエストします。このコマンドにより、Dgraphが複数の問合せ間で計算結果を再利用できるため、問合せ処理においてユーザーが識別可能な待機時間が削減され、パフォーマンスが向上します。データ・ドメインがクラスタ内で実行されている場合は、そのデータ・ドメインのすべてのDgraphプロセスに対してキャッシュ・ウォーミング・ジョブが実行されます。データ・ドメインに対して問合せを発行すると、Endeca Serverはキャッシュ・ウォーミングの問合せより先にその問合せを処理します。
Dgraphプロセスのキャッシュをウォーミング・アップするには、次の項目を指定します。
  • データ・ドメインの名前
  • timeLimitSec (オプション)。デフォルトは1800秒(30分)です。時間制限を指定しなかった場合に使用されます。
version 各データ・ドメインを動作させるDgraphプロセスのバージョン(これらのデータ・ドメインのDgraphプロセスが現在実行されている場合)とOracle Endeca Serverのバージョンをリストします。

このコマンドの使用時にデータ・ドメイン名の指定は不要です。

次の例は、データ・ドメイン作成における管理Webサービスのリクエストとレスポンスを示します。

この簡略例では、データ・ドメイン・プロファイルのmy_dd_profileに基づいてデータ・ドメインのmyDDを作成する管理Webサービス・リクエストを示します。作成されると、このデータ・ドメインは有効にされます。
<ns1:createDataDomain xmlns:ns1="http://www.endeca.com/endeca-server/manage/2/0">
      <ns1:name>myDD</ns1:name>
      <ns1:ddProfileName>my_dd_profile</ns1:ddProfileName>
      <ns1:enabled>true</ns1:enabled>
</ns1:createDataDomain>
この例では、管理Webサービスから空のcreateDataDomainResponseを示します。これは、データ・ドメインが正常に作成されたことを示します。
<ns3:createDataDomainResponse
    xmlns:ns2="http://www.endeca.com/endeca-server/types/2/0"
    xmlns:ns3="http://www.endeca.com/endeca-server/manage/2/0"/>

データ・ドメインが追加されていることを検証するには、listDataDomains操作を発行します。

既存のデータ・ドメイン・プロファイルに基づくと、Endeca Serverクラスタでデータ・ドメインを作成できないことがあります。たとえば、データ・ドメイン・プロファイルで、データ・ドメインにあるフォロワ・ノードの数をデプロイ済Endeca Serverノードの数よりも大きな数に指定した場合、この状況が発生することがあります。たとえば、単一のEndeca Serverノードをデプロイして、4つのフォロワ・ノードと専用リーダー・ノード(allowQueriesOnLeaderfalseに設定)のデータ・ドメイン・プロファイルを作成した際、次のようなエラーが発生する場合があります。
Request for 5 nodes would exceed configured maximum allowable number of oversubscribed nodes

要約すると、データ・ドメイン作成時にエラーが発生した場合、Endeca Serverノードの数と特性、および使用したデータ・ドメイン・プロファイルの構成を確認します。Endeca Serverクラスタが十分な数のEndeca Serverノードで構成され、十分なハードウェア処理能力があり、データ・ドメイン・プロファイルがデータ・ドメイン要件に一致することを確認します。詳細は、「過大サブスクライブがハードウェア使用率に影響を与える仕組み」「使用するデータ・ドメイン・プロファイルの決定」を参照してください。

注意: 管理Webサービスで使用される要素とタイプのリファレンス情報については、Oracle Endeca Server APIリファレンスの管理WebサービスAPIリファレンスに関する項を参照してください。