1. Cloud Controlデータベース・ライフサイクル・マネージメント管理者ガイド
  2. データベースのプロビジョニング
  3. Oracleスタンバイ・データベースのプロビジョニング

12 Oracleスタンバイ・データベースのプロビジョニング

この章の構成は、次のとおりです。

スタンバイ・データベースの作成の概要

スタンバイ・データベースを作成することは、データベースを管理してモニターする前に実行する必要がある最初の作業です。Enterprise Manager Cloud Controlには、1つのプライマリ・データベースと1つ以上のスタンバイ・データベースを含むBroker構成を作成するためのスタンバイ・データベースの追加ウィザードが用意されています。

フィジカル・スタンバイ・データベースまたはロジカル・スタンバイ・データベースを作成できます。フィジカル・スタンバイ・データベースは、プライマリ・データベースと物理的に同じものであり、リカバリ・モード時にマウントまたは読取り専用でオープンされ、すべてのデータ型とDDLをサポートしています。ロジカル・スタンバイ・データベースは、プライマリ・データベースとは物理的に異なり、リカバリ・モード時に読取り/書込みのみでオープンされます。また、データ保護およびレポート作成に使用でき、一部のデータベースとDDLのみをサポートしています。

スタンバイ・データベースの作成プロセスでは、次のステップが実行されます。

  • プライマリ・データベースの制御ファイル、データファイルおよびアーカイブREDOログ・ファイルのオンライン・バックアップ(または、必要に応じて既存のバックアップを使用)を実行します

  • プライマリ・ホストからスタンバイ・ホストにバックアップ・データを転送します

  • 必要なその他のファイル(初期化、パスワードなど)をスタンバイ・ホスト上に作成します

  • 制御ファイル、データファイルおよびアーカイブREDOログ・ファイルを、スタンバイ・ホスト上の指定した場所にリストアします

  • オンラインREDOログ・ファイルとその他のファイルを、必要に応じてスタンバイ・データベースに追加します

  • リカバリしたデータベースを、フィジカル・スタンバイ・データベースまたはロジカル・スタンバイ・データベースとして構成します

新規のフィジカル・スタンバイ・データベースの作成(単一インスタンスのみ)

新規のフィジカル・スタンバイ・データベースを作成するには(単一インスタンスのみ)、次のステップを実行します。

ノート:

新規のフィジカル・データベースが単一インスタンス・データベースとして作成されます。Enterprise Managerのクラスタ・データベースへの変換機能を使用して、スタンバイ・データベースを作成後、そのスタンバイ・データベースをクラスタ・データベースに変換できます。

  1. 「ターゲット」メニューから「データベース」を選択します。
  2. 「データベース」ページで、データベースのリストを確認します。新規フィジカル・スタンバイ・データベースを作成する対象のプライマリ・データベースを選択します。
  3. 「プライマリ・データベース」ホームページで、「可用性」をクリックしてから、「スタンバイ・データベースの追加」を選択します。
  4. 「データベース・ログイン」ページで、資格証明を入力します。「ログイン」をクリックします。

    ノート:

    プライマリ・データベースにまだ接続していない場合は、SYSDBA資格証明を使用して接続する必要があります。

    SYSDBA権限を持つユーザーとしてログインした場合は、すべてのモニタリングおよび管理機能など、Data Guardのすべての機能を使用できます。SYSDBA権限を持たないユーザーとしてログインした場合は、モニタリング機能のみを使用できます。スタンバイ・データベースの作成、スイッチオーバーおよびフェイルオーバーなどの機能は使用できません。

  5. 「スタンバイ・データベースの追加」ページで、「新規のフィジカル・スタンバイ・データベースの作成」を選択します。「続行」をクリックします。

    ノート:

    新規のフィジカル・スタンバイ・データベースまたはロジカル・スタンバイ・データベースを作成する場合、Data Guardでは、「続行」をクリックすると、次の項目がチェックされます。

    • サーバー・パラメータ・ファイル(SPFILE) -- Data Guardでは、構成内のすべてのデータベースがサーバー・パラメータ・ファイル(SPFILE)を使用する必要があります。SPFILEを使用していないプライマリ・データベースが見つかると、ウィザードは停止し、SPFILEの作成を要求するメッセージを戻します。デフォルト以外の名前で作成できます。Data Guardで必要になるのは、プライマリ・データベースがSPFILEを使用することのみです。

    • NOARCHIVELOGモード -- いずれの方法でスタンバイ・データベースを追加する場合も、プライマリ・データベースをARCHIVELOGモードに設定する必要があります。プライマリ・データベースがNOARCHIVELOGモードの場合は、ウィザードを終了して、プライマリ・データベースをARCHIVELOGモードに変更するように要求されます。

  6. スタンバイ・データベースの追加ウィザードが開きます。ウィザードでは、次のステップを実行します。

    • バックアップ・タイプの決定。

    • バックアップ・オプションの設定。

    • スタンバイ・データベースを作成するOracleホームの選択。

    • スタンバイ・データベース・ファイルの場所の設定。

    • スタンバイ・データベースの構成パラメータの指定。

    • 情報を確認してから「終了」をクリック。

ステップ1: バックアップ・タイプの決定

Enterprise Managerは、Oracle Recovery Manager (RMAN)を使用して、プライマリ・データベースの新規バックアップまたは既存のバックアップから単一インスタンスのスタンバイ・データベースを作成します。スタンバイ・データベースの作成で使用する2つのバックアップ操作のいずれかを選択できます。

  • プライマリ・データベース稼働中にバックアップを実行し、RMANを使用してデータベース・ファイルをコピーするか、またはステージング領域を介してデータベース・ファイルをコピーします。

  • 以前のスタンバイ・データベース作成時の既存のRMANバックアップまたは既存のバックアップを使用します。

「次」をクリックします。

「取消」をクリックして現在のプロセスを終了し、スタンバイ・データベースの追加ウィザードの最初のページから再度開始できます。

ステップ2: バックアップ・オプションの設定

RMANを使用したオンライン・バックアップの場合は、「並列度」を入力します(RMANがデータベース・ファイルをコピーするのに使用するパラレル・チャネルの数)。デフォルトの桁数は2です。

ステージング領域を介したデータベース・ファイルのコピーによるオンライン・バックアップの場合は、ステージング領域の場所を指定します。スタンバイ・データベースの作成後に、ディレクトリを保持または削除するよう選択することもできます。

RMANを使用したオンライン・バックアップの場合は、RMANバックアップの場所とステージング領域の場所を指定します。

プライマリ・ホストの資格証明を入力します。既存の資格証明を使用するか、または新しい資格証明を作成できます。新しい資格証明を作成した場合は、その資格証明を保存して、後で別のスタンバイ・データベースを作成する際に使用できます。これを実行するには、「優先資格証明として設定」ボックスをチェックします。

「次」をクリックします。

「取消」をクリックして現在のプロセスを終了し、スタンバイ・データベースの追加ウィザードの最初のページから再度開始できます。

ステップ3: スタンバイ・データベースを作成するOracleホームの選択

スタンバイ・データベースは、Oracle Enterprise Managerで検出された任意のOracleホームで作成できます。プライマリ・ホストのオペレーティング・システムに一致する、ホスト上のOracleホームのみが表示されます。検出されたOracleホームを選択し、スタンバイ・データベースに対して一意のインスタンス名を指定する必要があります。続行するには、スタンバイ・ホストの資格証明が必要です。

ステップ4: スタンバイ・データベース・ファイルの場所の設定

プライマリ・データベースとスタンバイ・データベースは同じホスト上に存在するため、スタンバイ・データベース・ファイルは、Oracle Optimal Flexible Architecture (OFA)ディレクトリ構造に置かれます。「カスタマイズ」をクリックして、個々のファイル名を変更します。

「リスナー構成」セクションで、スタンバイ・データベースで使用するリスナーの名前とポートを指定します。既存のリスナーが使用していない新しい名前とポートを指定すると、指定したポートを使用する新しいリスナーが作成されます。

「次」をクリックします。

「取消」をクリックして現在のプロセスを終了し、スタンバイ・データベースの追加ウィザードの最初のページから再度開始できます。

ステップ5: スタンバイ・データベースの構成パラメータの指定

スタンバイ・データベースの構成パラメータを設定する必要があります。これらのパラメータには、データベース名、データベースの一意の名前、ターゲット名およびスタンバイ・アーカイブの場所などが含まれます。スタンバイ・アーカイブの場所は、通常のディレクトリまたはフラッシュのリカバリ領域に設定できます。デフォルト値は、対応するプライマリ・データベースの設定に基づいています。

パラメータが正しいことを確認したら、「次」をクリックします。

「取消」をクリックして現在のプロセスを終了し、スタンバイ・データベースの追加ウィザードの最初のページから再度開始できます。

ステップ6: 情報を確認してから「終了」をクリック

スタンバイ・データベースの追加ウィザードでは、構成およびスタンバイ・データベースに対して最後に入力したデータを確認できます。情報がすべて正しいことを確認したら、「終了」をクリックします。

「取消」をクリックして現在のプロセスを終了し、スタンバイ・データベースの追加ウィザードの最初のページから再度開始できます。

「スタンバイ・データベース記憶域」をクリックすると、スタンバイ・データベース・ファイルのすべての場所に関する詳細な情報を表示できます。

「終了」をクリックすると、スタンバイ・データベースの作成プロセスがOracle Enterprise Managerのジョブとして実行されます。ジョブを発行する前であればいつでもスタンバイの作成を取り消すことができます。

ジョブが発行されると、「Data Guardの概要」ページが表示されます。「スタンバイ・データベース」表の「ステータス」列に、「作成の進行中」が一覧表示されます。そのリンクをクリックすると、スタンバイ・データベース作成の進行状況をモニターできます。

ノート:

最初に構成を作成した後にスタンバイ・データベースを追加するには、「スタンバイ・データベースの追加」をクリックして、再度スタンバイ・データベースの追加ウィザードを実行します。

新規のロジカル・スタンバイ・データベースの作成(単一インスタンスのみ)

新規のフィジカル・スタンバイ・データベースを作成するには(単一インスタンスのみ)、次のステップを実行します。

ノート:

新規のロジカル・スタンバイ・データベースが単一インスタンス・データベースとして作成されます。Enterprise Managerのクラスタ・データベースへの変換機能を使用して、スタンバイ・データベースを作成後、そのスタンバイ・データベースをクラスタ・データベースに変換できます。

  1. 「ターゲット」メニューから「データベース」を選択します。

  2. 「データベース」ページで、データベースのリストを確認します。新規フィジカル・スタンバイ・データベースを作成する対象のプライマリ・データベースを選択します。

  3. 「プライマリ・データベース」ホームページで、「可用性」をクリックしてから、「スタンバイ・データベースの追加」を選択します。

  4. 「データベース・ログイン」ページで、資格証明を入力します。「ログイン」をクリックします。

    ノート:

    プライマリ・データベースにまだ接続していない場合は、SYSDBA資格証明を使用して接続する必要があります。

    SYSDBA権限を持つユーザーとしてログインした場合は、すべてのモニタリングおよび管理機能など、Data Guardのすべての機能を使用できます。SYSDBA権限を持たないユーザーとしてログインした場合は、モニタリング機能のみを使用できます。スタンバイ・データベースの作成、スイッチオーバーおよびフェイルオーバーなどの機能は使用できません。

  5. 「スタンバイ・データベースの追加」ページで、「新規のフィジカル・スタンバイ・データベースの作成」を選択します。「続行」をクリックします。

    ノート:

    新規のフィジカル・スタンバイ・データベースまたはロジカル・スタンバイ・データベースを作成する場合、Data Guardでは、「続行」をクリックすると、次の項目がチェックされます。

    • サーバー・パラメータ・ファイル(SPFILE) -- Data Guardでは、構成内のすべてのデータベースがサーバー・パラメータ・ファイル(SPFILE)を使用する必要があります。SPFILEを使用していないプライマリ・データベースが見つかると、ウィザードは停止し、SPFILEの作成を要求するメッセージを戻します。デフォルト以外の名前で作成できます。Data Guardで必要になるのは、プライマリ・データベースがSPFILEを使用することのみです。

    • NOARCHIVELOGモード -- いずれの方法でスタンバイ・データベースを追加する場合も、プライマリ・データベースをARCHIVELOGモードに設定する必要があります。プライマリ・データベースがNOARCHIVELOGモードの場合は、ウィザードを終了して、プライマリ・データベースをARCHIVELOGモードに変更するように要求されます。

  6. 「データベース」ページの「スタンバイ・データベース」セクションで、「スタンバイ・データベースの追加」をクリックします。

  7. 次のステップでは、1つのプライマリ・データベースと1つのフィジカル・スタンバイ・データベースを含むBroker構成がすでに存在していると仮定して、新規のロジカル・スタンバイ・データベースを作成します。次に、ウィザードにおいて、データベース用のOracleホームを選択して、データファイルをスタンバイ・データベースにコピーする詳細なステップを示します。

    スタンバイ・データベースの追加ウィザードでは、次のステップを実行します。

    1. バックアップ・タイプの決定。

    2. バックアップ・オプションの設定。

    3. スタンバイ・データベースを作成するOracleホームの選択。

    4. スタンバイ・データベース・ファイルの場所の設定。

    5. スタンバイ・データベースの構成パラメータの指定。

    6. 情報を確認してから「終了」をクリック。

ステップ1: バックアップ・タイプの決定

Enterprise Managerは、Oracle Recovery Manager (RMAN)を使用して、プライマリ・データベースの新規バックアップまたは既存のバックアップから単一インスタンスのスタンバイ・データベースを作成します。スタンバイ・データベースの作成で使用する2つのバックアップ操作のいずれかを選択できます。

  • プライマリ・データベース稼働中にバックアップを実行します。

  • プライマリ・データベースの既存のバックアップを使用します。

「取消」をクリックして現在のプロセスを終了し、スタンバイ・データベースの追加ウィザードの最初のページから再度開始できます。

ステップ2: バックアップ・オプションの設定

プライマリ・データベースのバックアップ・ファイルを格納するための作業ディレクトリが必要です。将来の使用に備え、必要に応じて、追加のスタンバイ・データベースを作成するために保持して使用できます。作業ディレクトリを作成する、プライマリ・ホスト上の場所を指定します。

このステップでは、プライマリ・ホストの資格証明が必要になります。プライマリ・データベースのOracleサーバー・インストールの所有者の資格証明を入力します。この資格証明を保存するには、「優先資格証明として保存」ボックスをチェックします。

「取消」をクリックして現在のプロセスを終了し、スタンバイ・データベースの追加ウィザードの最初のページから再度開始できます。

ステップ3: スタンバイ・データベースを作成するOracleホームの選択

スタンバイ・データベースは、Oracle Enterprise Managerで検出された任意のOracleホームで作成できます。プライマリ・ホストのオペレーティング・システムに一致する、ホスト上のOracleホームのみが表示されます。検出されたOracleホームを選択し、スタンバイ・データベースに対して一意のインスタンス名を指定する必要があります。続行するには、スタンバイ・ホストの資格証明が必要です。

ステップ4: スタンバイ・データベース・ファイルの場所の設定

Broker構成の作成プロセスの一部として、プライマリ・データベースのデータファイルをスタンバイ・ホストが使用できるようにする操作があります。スタンバイ・データベース・ファイルの場所をカスタマイズするオプションもあります。続行するには、スタンバイ・ホストの資格証明が必要です。次のリストで、オプションについて説明します。

  • バックアップ・ファイルへのアクセス・メソッドの指定

    スタンバイ・ホストがプライマリ・データベースのバックアップ・ファイルにアクセスするためのメソッドを選択します。次の2つのオプションがあります。

    • プライマリ・ホストの作業ディレクトリからスタンバイ・ホストの作業ディレクトリへのファイルの転送

    • ネットワーク・パス名を使用した、スタンバイ・ホストからプライマリ・ホストの作業ディレクトリの場所への直接アクセス

  • スタンバイ・データベース・ファイルの場所の指定

    スタンバイ・データベース・ファイルの場所を選択します。次の2つのオプションがあります。

    • Oracle OFA (Optimal Flexible Architecture)への変換

    • プライマリ・データベースと同じファイル名と場所を保持

  • ネットワーク構成ファイルの場所の指定

    Data Guardでは、スタンバイ・データベースの構成情報が、スタンバイ・ホスト上で指定したディレクトリ内のネットワーク構成ファイル(listener.oraファイルとtnsnames.oraファイル)に追加されます。

「取消」をクリックして現在のプロセスを終了し、スタンバイ・データベースの追加ウィザードの最初のページから再度開始できます。

ステップ5: スタンバイ・データベースの構成パラメータの指定

スタンバイ・データベースの構成パラメータを設定する必要があります。これらのパラメータには、データベース名、データベースの一意の名前、ターゲット名およびスタンバイ・アーカイブの場所などが含まれます。スタンバイ・アーカイブの場所は、通常のディレクトリまたはフラッシュのリカバリ領域に設定できます。デフォルト値は、対応するプライマリ・データベースの設定に基づいています。

「取消」をクリックして現在のプロセスを終了し、スタンバイ・データベースの追加ウィザードの最初のページから再度開始できます。

ステップ6: 情報を確認してから「終了」をクリック

スタンバイ・データベースの追加ウィザードでは、構成およびスタンバイ・データベースに対して最後に入力したデータを確認できます。情報がすべて正しいことを確認したら、「終了」をクリックします。

「取消」をクリックして現在のプロセスを終了し、スタンバイ・データベースの追加ウィザードの最初のページから再度開始できます。

「スタンバイ・データベース記憶域」をクリックすると、スタンバイ・データベース・ファイルのすべての場所に関する詳細な情報を表示できます。

「終了」をクリックすると、スタンバイ・データベースの作成プロセスがOracle Enterprise Managerのジョブとして実行されます。ジョブを発行する前であればいつでもスタンバイの作成を取り消すことができます。

ジョブが発行されると、「Data Guardの概要」ページが表示されます。「スタンバイ・データベース」表の「ステータス」列に、「作成の進行中」が一覧表示されます。そのリンクをクリックすると、スタンバイ・データベース作成の進行状況をモニターできます。

ノート:

最初に構成を作成した後にスタンバイ・データベースを追加するには、「スタンバイ・データベースの追加」をクリックして、再度スタンバイ・データベースの追加ウィザードを実行します。

Data Guard Brokerを使用した既存のスタンバイ・データベースの管理

既存のスタンバイ・データベースを追加するには、次のステップを実行します。

  1. 「ターゲット」メニューから「データベース」を選択します。
  2. 「データベース」ページで、データベースのリストを確認します。既存のスタンバイ・データベースを管理するデータベースを選択します。
  3. 「プライマリ・データベース」ホームページで、「可用性」をクリックしてから、「スタンバイ・データベースの追加」を選択します。
  4. 「データベース・ログイン」ページで、資格証明を入力します。「ログイン」をクリックします。

    ノート:

    プライマリ・データベースにまだ接続していない場合は、SYSDBA資格証明を使用して接続する必要があります。

    SYSDBA権限を持つユーザーとしてログインした場合は、すべてのモニタリングおよび管理機能など、Data Guardのすべての機能を使用できます。SYSDBA権限を持たないユーザーとしてログインした場合は、モニタリング機能のみを使用できます。スタンバイ・データベースの作成、スイッチオーバーおよびフェイルオーバーなどの機能は使用できません。

  5. 「スタンバイ・データベースの追加」ページで、「Data Guard Brokerを使用した既存のスタンバイ・データベースの管理」 を選択します。
  6. Data Guard Brokerで管理する既存のスタンバイ・データベースを選択します。選択したデータベースはプライマリ・データベースから作成して、スタンバイ・データベースとして機能するように構成する必要があります。

    環境内で検出されたすべてのデータベース(RACデータベースとRAC以外のデータベースの両方)がリストに表示されます。

    「次」をクリックします。

    ノート:

    随時「取消」をクリックして現在のプロセスを終了し、スタンバイ・データベースの追加ウィザードの最初のページから再度開始できます。

  7. データベースのログイン資格証明を入力します。「名前付き」資格証明または「新規」資格証明を選択できます。新規の資格証明の場合は、一意の資格証明を作成します。この資格証明を再度使用する場合は、「優先資格証明」に設定します。

    「次」をクリックします。

  8. (オプション)既存のスタンバイ・クラスタ・データベースの「スタンバイ・アーカイブの場所」の設定を変更します。「次」をクリックします。
  9. 構成およびスタンバイ・データベースのデータを確認します。「終了」をクリックします

プライマリ・データベースのバックアップのみを作成

追加オプションでは、スタンバイ・データベースを作成せずにプライマリ・データベースのバックアップのみを作成します。このバックアップは、将来スタンバイ・データベースを作成する場合(スタンバイ・データベースの追加ウィザードを再度実行して、既存のバックアップからスタンバイ・データベースを作成)に使用できます。既存のバックアップは、プライマリ・ホストまたはスタンバイ・ホストから使用できます。Enterprise Managerが提供するプライマリ・ホストからスタンバイ・ホストへのバックアップ・ファイル転送用のファイル転送メカニズムを使用できず、かわりに独自のメカニズムを使用してスタンバイ・ホストにバックアップ・ファイルを転送およびステージングする場合に、このオプションを検討してください。

プライマリ・データベースのバックアップのみを作成するには、次のステップを実行します。

  1. 「ターゲット」メニューから「データベース」を選択します。
  2. 「データベース」ページで、データベースのリストを確認します。既存のスタンバイ・データベースを管理するデータベースを選択します。
  3. 「プライマリ・データベース」ホームページで、「可用性」をクリックしてから、「スタンバイ・データベースの追加」を選択します。
  4. 「データベース・ログイン」ページで、資格証明を入力します。「ログイン」をクリックします。

    ノート:

    プライマリ・データベースにまだ接続していない場合は、SYSDBA資格証明を使用して接続する必要があります。

    SYSDBA権限を持つユーザーとしてログインした場合は、すべてのモニタリングおよび管理機能など、Data Guardのすべての機能を使用できます。SYSDBA権限を持たないユーザーとしてログインした場合は、モニタリング機能のみを使用できます。スタンバイ・データベースの作成、スイッチオーバーおよびフェイルオーバーなどの機能は使用できません。

  5. 「スタンバイ・データベースの追加」ページで、プライマリ・バックアップのみを作成を選択します。

    「続行」をクリックします。

  6. 「バックアップ・オプション」ページで、プライマリ・データベースのバックアップ・ファイルを格納するためのディレクトリを作成する、プライマリ・ホスト上の場所を指定します。「次」をクリックします。
  7. 「スケジュール」ページで、バックアップ・ジョブの名前、説明および開始時間を指定します。

    バックアップをすぐに開始するか、または後で開始するかを選択できます。後で開始する場合は、バックアップを開始する日時を設定します。

    「次」をクリックします。

  8. 構成およびスタンバイ・データベースのデータを確認します。「終了」をクリックします

データベース高可用性REST API

この章では、Enterprise Managerでサポートされているデータベース高可用性向けのREST APIの詳細について説明します。Data Guardを有効にすると、リソース集中型のバックアップおよびレポート生成操作をスタンバイ・システムにオフロードすることで、本番データベースのパフォーマンスを改善できます。

Data Guard

Data GuardスイッチオーバーREST API

表12-1 Data Guardスイッチオーバー

機能 説明

URL

https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/db/dataguard/switchover

リクエスト・ヘッダー

Authorization: basic

Content-Type: application/json

本文

 
{
    "primaryTargetName" : "<primary target name>",
    "primaryTargetType" : "oracle_database|rac_database",
    "standbyTargetName" : "<standby target name>",
    "standbyTargetType" : "oracle_database|rac_database",
    ["primaryDbCredsName" : "<primary database credential name>",]
    ["primaryHostCredsName" : "<primary database host credential name>",]
    ["standbyDbCredsName" : "<standby database credential name>",]
    ["standbyHostCredsName" : "<standby database host credential name>",]
    ["swapJobs" : "false|true",]
    ["swapThresholds" : "false|true",]
    ["tdeWalletCredsName" : "<transparent data encryption wallet credentials of the primary database>"]
    ["tdeWalletPassword"  :  "<transparent data encryption wallet password of the primary database>"]
}

リクエスト・メソッド

POST

サンプル本文

 
{
    "primaryTargetName" : "dbname", 
    "primaryTargetType" : "oracle_database", 
    "standbyTargetName" : "sdbname", 
    "standbyTargetType" : "oracle_database", 
    "primaryDbCredsName" : "SYS", 
    "primaryHostCredsName" : "AIMEDB_N", 
    "standbyDbCredsName" : "SYS", 
    "standbyHostCredsName" : "AIMEDB_N", 
    "swapJobs" : "true", 
    "swapThresholds" : "true", 
    "tdeWalletCredsName" : "WC1"
}

サンプル・レスポンス

 
{
    "status": "Succeeded",
    "submissionName": "dbname_DataguardSwitchover_091418163542",
    "executionGUID": "75D3A124B36D1A4DE0536A8A7B0A80E0",
    "databaseName": "dbname",
    "message": "Deployment procedure for switchover to dbname:oracle_database successfully submitted."
}

サポート開始リリース

EM DB 13.3.2.0.0

ノート:

大カッコ内に示されたパラメータはオプションです。

表12-2 Data Guardスイッチオーバーのパラメータ

パラメータ 説明
primaryTargetName

プライマリ・データベースのEnterprise Managerターゲット名。単一インスタンス・データベースまたはクラスタ・データベースのいずれも可能です。
primaryTargetType

プライマリ・データベースのターゲット・タイプ。指定可能な値は、単一インスタンス・データベース(oracle_database)またはクラスタ・データベース(rac_database)のどちらかです。
standbyTargetName

スタンバイ・データベースのEnterprise Managerターゲット名。単一インスタンス・データベースまたはクラスタ・データベースのいずれも可能です。
standbyTargetType

スタンバイ・データベースのターゲット・タイプ。指定可能な値は、単一インスタンス・データベース(oracle_database)またはクラスタ・データベース(rac_database)のどちらかです。
primaryDbCredsName

SYSDBAまたはSYSDGロールを持つユーザーのプライマリ・データベースの名前付き資格証明。この引数が指定されない場合は、優先資格証明が使用されます。
primaryHostCredsName

プライマリ・データベースのOracleホームにアクセスできるオペレーティング・システム・ユーザーのプライマリ・データベース・ホストの名前付き資格証明。この引数が指定されない場合は、優先資格証明が使用されます。
standbyDbCredsName

SYSDBAまたはSYSDGロールを持つユーザーのスタンバイ・データベースの名前付き資格証明。この引数が指定されない場合は、優先資格証明が使用されます。
standbyHostCredsName

スタンバイ・データベースのOracleホームにアクセスできるオペレーティング・システム・ユーザーのスタンバイ・データベース・ホストの名前付き資格証明。
swapJobs

スイッチオーバーの完了後に、プライマリ・データベースまたはスタンバイ・データベースの転送可能タイプのスケジュール済ジョブ(バックアップ、RMANスクリプトおよびSQLスクリプト)を別のデータベースに移動するかどうかを指定します。転送可能なジョブは、グローバル名または優先資格証明を使用するジョブのみです。デフォルト値: 無効。
swapThresholds

スイッチオーバーの完了後、プライマリ・データベースとスタンバイ・データベースの間でモニタリング設定がスワップされるように指定します。

デフォルト値: 無効
tdeWalletCredsName

プライマリ・データベースの透過的データ暗号化ウォレット資格証明。次に示すようにcreate_named_credential動詞を使用して、これらの資格証明を作成します。

emcli create_named_credential -cred_name=WC1 -cred_type=GenericPassword -auth_target_type='<system>' -attributes="GENERIC_PASSWORD:<Primary Database TDE Wallet Password>"
tdeWalletPassword

プライマリ・データベースの透過的データ暗号化ウォレット・パスワード。

スタンバイ・データベースの変換REST API

表12-3 スタンバイ・データベースの変換

機能 説明

URL

https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/db/dataguard/convertStandby

リクエスト・ヘッダー

Authorization: basic

Content-Type: application/json

本文

 
{
    "dbTargetName" : "<standby target name>",
    "dbTargetType" : "oracle_database|rac_database",
    ["dbHostCredName" : "<standby database host credential name>",] 
    ["dbCredName" : "<standby database credential name>",]
    ["convertToDbRole" : "PHYSICAL STANDBY|SNAPSHOT STANDBY" ]
}

サンプル本文

 
{
    "dbTargetName": "s11gfss",
    "dbTargetType":"oracle_database",
    "dbHostCredName": "GIMAN_N",
    "dbCredName": "SYSDBA_CREDS", 
    "convertToDbRole": "snapshot"
}

サンプル・レスポンス

 
{
    "status":"Succeeded",
    "submissionName":"dbname_DGConvertStandby_092318020955",
    "executionGUID":"76815E6ABC9465F5E053C365F20A61AF",
    "databaseName":"dbname",
    "message":"Deployment procedure to convert the standby database successfully submitted."
}

リクエスト・メソッド

POST

サポート開始リリース

EM DB 13.3.2.0.0

表12-4 スタンバイ・データベースの変換のパラメータ

パラメータ 説明
dbTargetName

スタンバイ・データベースのEnterprise Managerターゲット名。単一インスタンス・データベースまたはクラスタ・データベースのいずれも可能です。
dbTargetType

スタンバイ・データベースのターゲット・タイプ。指定可能な値は、単一インスタンス・データベース(oracle_database)またはクラスタ・データベース(rac_database)のどちらかです。
dbHostCredName

スタンバイ・データベースのOracleホームにアクセスできるオペレーティング・システム・ユーザーのスタンバイ・データベース・ホストの名前付き資格証明。この引数が指定されない場合は、優先資格証明が使用されます。
dbCredName

SYSDBAまたはSYSDGロールを持つユーザーのスタンバイ・データベースの名前付き資格証明。この引数が指定されない場合は、優先資格証明が使用されます。
convertToDbRole

指定のロールに変換されるスタンバイ・データベース・ロール。指定可能な値は、フィジカル・スタンバイおよびスナップショット・スタンバイです。

バックアップおよびリカバリ

バックアップの構成REST API

表12-5 バックアップを送信するためのデータベースの構成

機能 説明

URL

https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/db/backup/configure

リクエスト・ヘッダー

Authorization: basic

Content-Type: application/json

Body1

データベースがリカバリ・アプライアンスで保護されるようにするために、リカバリ・アプライアンスにバックアップを送信できるように構成します。

{
    "dbTargetName":"<database target name>",
    "dbTargetType":"oracle_database|rac_database",
    "configureRABackup":"true"
    "raTargetName":"<Recovery Appliance target name>"
    "raUser":"<Recovery Appliance database user name>"
    ["dbCredName":"<database named credential>"],
    ["dbHostCredName":"<database host named credential>"],
    ["enableRedoShip":"true"]
    ["forceBackupModuleInstall":"true"]
}

サンプル本文

 
{
    "configureRABackup":"true",
    "dbTargetType":"oracle_database",
    "dbTargetName":"zd2", 
    "raTargetName":"ra",
    "raUser":"orsadmin",
    "dbCredName": "RMAN",
    "dbHostCredName":"AIMEDB_N"
}

サンプル・レスポンス

 
{
    "status":"Succeeded",
    "submissionName":"BACKUP_CONFIG_011419155235",
    "executionGUID":"7F69505339B4413FE053EB987B0A226E",
    "databaseName":"zd2",
    "message":"Deployment procedure to configure high availability settings to database successfully submitted."
}

Body2

Oracle Database Backup Cloud Serviceにバックアップを送信するように、データベースを構成します。

{
    "dbTargetName":"<database target name>",
    "dbTargetType":"oracle_database|rac_database",
    "configureCloudBackup":"true",
    ["dbCredName":"<database named credential>"],
    ["dbHostCredName":"<database host named credential>"],
    ["forceBackupModuleInstall":"true"]
    ["cloudAccount":"<Hybrid Cloud Console cloud service account name>"]
}

サンプル本文

 
{
    "configureCloudBackup":"true",
    "dbTargetType":"oracle_database", 
    "dbTargetName":"dgprim", 
    "dbHostCredName":"GIMAN_N", 
    "dbCredName": "SYS",
    "cloudAccount":"endpoint:https://storage.example.com/v1/Storage-emdev2;identityDomain:emdev2;username:xxxx;password:xxxx;container:db19_cntr"
}

サンプル・レスポンス

 
{
    "status":"Succeeded",
    "submissionName":"OPC_BACKUP_CONFIG_010919120757",
    "executionGUID":"7F000E71E0DE624BE053EB987B0ADF02",
    "databaseName":"dgprim",
    "message":"Deployment procedure to configure high availability settings to database successfully submitted."
}

Body3

指定したデータベースのOracleホームにRMANバックアップ・モジュールをインストールするか、データベースのホストにリカバリ・アプライアンス・ファイル・システム・バックアップ・エージェントをインストールします。

{
    "dbTargetName":"<database target name>",
    "dbTargetType":"oracle_database|rac_database",
    "installSoftware":"true",
    "moduleType":"ra|cloud",
    "installBackupModule":"true",
    ["dbHostCredName":"<database host named credential>"],
    ["forceBackupModuleInstall":"true"]
}

サンプル本文

 
{
    "installSoftware":"true",
    "dbTargetType":"oracle_database", 
    "dbTargetName":"dgprim", 
    "moduleType":"cloud",
    "installBackupModule":"true",
    "dbHostCredName":"GIMAN_N"
}

サンプル・レスポンス

 
{
    "status":"Succeeded",
    "submissionName":"INSTALL_BKP_MODULE_011019111214",
    "executionGUID":"7F1502D6C5CB5E53E053EB987B0AA38E",
    "databaseName":"dgprim",
    "message":"Deployment procedure to configure high availability settings to database successfully submitted."
}

リクエスト・メソッド

POST

サポート開始リリース

EM DB 13.3.2.0.0

表12-6 バックアップの構成のパラメータ

パラメータ 説明
Body1
dbTargetName

リカバリ・アプライアンスにバックアップを送信するように構成されるデータベースの単一インスタンスまたはクラスタ・データベース・ターゲット名。
dbTargetType

"dbTargetName"で指定されたターゲットのタイプ。単一インスタンス・データベース(oracle_database)またはクラスタ・データベース(rac_database)のどちらかになります。
configureRABackup

データベースがリカバリ・アプライアンスで保護されるようにするために、リカバリ・アプライアンスにバックアップを送信できるように構成します。configureRABackup、configureCloudBackupまたはinstallSoftwareのいずれか1つのオプションを指定する必要があります。指定可能な値は"true"です。

dbCredName

指定したターゲット・データベースへの接続に使用できる、既存のEnterprise Managerデータベースの名前付き資格証明の名前。この引数が指定されない場合は、優先資格証明が使用されます。
dbHostCredName

指定したターゲット・データベース・ホストでオペレーティング・システムのコマンドを実行するために使用できる、既存のEnterprise Managerデータベース・ホストの名前付き資格証明の名前。資格証明は、Oracleホームに対する書込み権限を持つユーザーのものであることが必要です。この引数が指定されない場合は、優先資格証明が使用されます。
raTargetName

指定したデータベースのバックアップの送信先として構成されるリカバリ・アプライアンスのターゲット名。
raUser

指定したデータベースが、リカバリ・アプライアンスへのバックアップとREDOの送信に使用するリカバリ・アプライアンス・データベース・ユーザーの名前。これには、リカバリ・アプライアンスの管理者ユーザーではなく、仮想プライベート・カタログ・ユーザーを指定する必要があります。
enableRedoShip

指定したターゲット・データベースからのリカバリ・アプライアンスへのリアルタイムREDOトランスポートを有効にします。

デフォルト値: True

forceBackupModuleInstall

Enterprise Managerソフトウェア・ライブラリに格納されているリカバリ・アプライアンス・バックアップ・モジュールのバージョンを、指定のターゲット・データベースのOracleホームに強制的に(Oracleホームにインストールされた既存のバックアップ・モジュールが存在していても)インストールします。このオプションにより既存のバックアップ・モジュールが上書きされます。そのため、このオプションは、ソフトウェア・ライブラリにあるバックアップ・モジュールのバージョンが指定したターゲット・データベースにインストールされているバージョン以降であるとわかっている場合にのみ指定してください。このオプションを指定しないと、バックアップ・モジュールはOracleホームに既存のバックアップ・モジュールが存在していない場合にのみインストールされます。

デフォルト値: True

Body2
dbTargetName

バックアップを送信するように構成されるデータベースの単一インスタンスまたはクラスタ・データベース・ターゲット名
dbTargetType

"dbTargetName"で指定されたターゲットのタイプ。単一インスタンス・データベース(oracle_database)またはクラスタ・データベース(rac_database)のどちらかになります。

configureCloudBackup

Oracle Database Backup Cloud Serviceにバックアップを送信するように、データベースを構成します。configureRABackup、configureCloudBackupまたはinstallSoftwareのいずれか1つのオプションを指定する必要があります。指定可能な値は"true"です。

dbCredName

指定したターゲット・データベースへの接続に使用できる、既存のEnterprise Managerデータベースの名前付き資格証明の名前。この引数が指定されない場合は、優先資格証明が使用されます。

dbHostCredName

指定したターゲット・データベース・ホストでオペレーティング・システムのコマンドを実行するために使用できる、既存のEnterprise Managerデータベース・ホストの名前付き資格証明の名前。資格証明は、Oracleホームに対する書込み権限を持つユーザーのものであることが必要です。この引数が指定されない場合は、優先資格証明が使用されます。
forceBackupModuleInstall

Enterprise Managerソフトウェア・ライブラリに格納されているOracle Database Cloudバックアップ・モジュールのバージョンを、指定のターゲット・データベースのOracleホームに強制的に(Oracleホームにインストールされた既存のバックアップ・モジュールが存在していても)インストールします。このオプションにより既存のバックアップ・モジュールが上書きされます。そのため、このオプションは、ソフトウェア・ライブラリにあるバックアップ・モジュールのバージョンが指定したターゲット・データベースにインストールされているバージョン以降であるとわかっている場合にのみ指定してください。このオプションを指定しないと、バックアップ・モジュールはOracleホームに既存のバックアップ・モジュールが存在していない場合にのみインストールされます。

cloudAccount

Enterprise ManagerのHybrid Cloud設定コンソールで構成したクラウド・アカウントの名前。Backup Serviceに接続するために必要なすべての情報(サービス名、アイデンティティ・ドメイン、ユーザー名、パスワード、コンテナ(オプション)など)は、このアカウントとそれに関連するBackup Service設定から取得されます。この引数が指定されない場合、Database BackupのCloud Service設定ページで構成したグローバル・クラウド・アカウント設定が使用されます。(この引数を適用できるのは、Hybrid Cloud設定コンソールを使用して、アカウントとBackup Service設定を構成した場合のみです)。このフィールドは、"configureCloudBackup"オプションで指定する必要があります。

例: "cloudAccount":"endpoint:https://storage.oracle.com/ Storageemdev2;identityDomain:xxx;username:xxxx;password:xxxx;contai ner:xxxx"

Body3
dbTargetName

前述の-configureRABackupの使用方法と同じです。
dbTargetType

前述の-configureRABackupの使用方法と同じです。
installSoftware

1つ以上のデータベースのOracleホームにRMANバックアップ・モジュールをインストールするか、1つのデータベースのホストにリカバリ・アプライアンス・ファイル・システム・バックアップ・エージェントをインストールします。configureRABackup、configureCloudBackupまたはinstallSoftwareのいずれか1つのオプションを指定します。指定可能な値は"true"です。

dbHostCredName

前述の-configureRABackupの使用方法と同じです。
installBackupModule

Enterprise Managerソフトウェア・ライブラリに格納されているバックアップ・モジュール(moduleTypeオプションで指定したタイプのモジュール)のバージョンを、指定したターゲット・データベースのOracleホームにインストールします。デフォルトでは、force_backup_module_installフラグを指定していないと、モジュールはデータベースのOracleホームに既存のモジュールが存在しない場合のみインストールされます。
moduleType

インストールされるRMANバックアップ・モジュールのタイプ。指定可能な値:

  • ra: リカバリ・アプライアンス・バックアップ・モジュール
  • cloud: Oracle Database Cloudバックアップ・モジュール
forceBackupModuleInstall

installBackupModuleオプションと組み合せて使用します。前述の-configureRABackupの使用方法と同じです。

バックアップREST API

この項では、バックアップREST APIの詳細について説明します。

表12-7 バックアップ

機能 説明

URL

https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/db/backup

リクエスト・ヘッダー

Authorization: basic

Content-Type: application/json

本文

データベースがリカバリ・アプライアンスで保護されるようにするために、リカバリ・アプライアンスにバックアップを送信できるように構成します。

{
    "dbTargetName":"<database target name>",
    "dbTargetType":"oracle_database|rac_database|oracle_cloud_dbcs",
    ["dbCredName":"<database named credential>"],
    ["dbHostCredName":"<database host named credential>"],
    ["scope":"wholeDB|tablespace|datafile|archivedLog|,recoveryFilesOnDisk|cdbRoot|pluggableDbs"],
    ["scopeValue":"<comma-separated list of values>"],
    ["backupType":"full|incr0|incr1" ["incrType:"diff|cumulative"]],
    ["destinationMedia":"disk|tape|ra|cloud"],
    ["skipBackupArchivedLogs":"true|false"],
    ["deleteArchivedLogsAfterBackup":"true|false"],
    ["deleteObsolateBackups":"true|false"],
    ["maxFilesPerSet":"<numeric value>"],
    ["maxCorruptions":"<numeric value>"],
    ["sectionSize":"<numeric value>"],
    [["backupEncryptionMode":"wallet|password|both"],
    ["rmanEncryptionCredName":"<RMAN encryption named credential>"],
    ["encryptionAlogrithm":"AES128|AES192|AES256"]],
    ["cloudAccount":"<cloud storage container url with endpoint, identityDomain, username,passoword and container name>"]
}

リクエスト・メソッド

POST

サポート開始リリース

EM DB 13.3.2.0.0

サンプル本文

 
{
    "dbTargetType":"oracle_database", 
    "dbTargetName":"dgprim", 
    "dbHostCredName":"GIMAN_N", 
    "dbCredName": "SYS", 
    "scope":"wholeDB", 
    "backupType":"full", 
    "backupEncryptionMode":"password",
    "encryptionAlogrithm":"AES128",
    "rmanEncryptionCredName":"WC1",
    "cloudAccount":"endpoint:https://storage.example.com/v1/Storage-emdev2;identityDomain:emdev2;username:xxxx;password:xxx;container:db19_cntr", 
    "destinationMedia":"cloud", 
    "maxFilesPerSet":2
}

サンプル・レスポンス

 
{
    "status":"Succeeded",
    "submissionName":"Backup_DB_from_OMC_010919152109",
    "executionGUID":"7F044AF2D1F60905E053EB987B0A569B",
    "databaseName":"dgprim",
    "message":"Backup to Oracle Cloud deployment procedure successfully submitted."
}

表12-8 バックアップのパラメータ

パラメータ 説明
Body1
dbTargetName

バックアップされるデータベースの単一インスタンス、クラスタ・データベースまたはデータベース・クラウド・サービスのターゲット名。
dbTargetType

"dbTargetName"で指定したターゲットのタイプ。単一インスタンス・データベース(oracle_database)、クラスタ・データベース(rac_database)またはデータベース・クラウド・サービス(oracle_cloud_dbcs)のいずれかです。
dbCredName

指定したターゲット・データベースの接続に使用できる、既存のEnterprise Managerデータベースの名前付き資格証明の名前。"dbHostCredName"引数で指定したオペレーティング・システム・ユーザーがオペレーティング・システムDBAグループのメンバーである場合は、データベース資格証明で通常ロール・ユーザーを指定できます。それ以外の場合は、データベース資格証明でSYSDBAロール・ユーザーを指定する必要があります。この引数を指定しないと、優先資格証明が使用されます。
dbHostCredName

指定したターゲット・データベース・ホストでRMANコマンドを実行するために使用できる、既存のEnterprise Managerデータベース・ホストの名前付き資格証明の名前。この引数を指定しないと、優先資格証明が使用されます。
scope

バックアップの範囲。この引数が指定されていない場合、デフォルト値はwholeDBです。指定可能な値は次のとおりです:

  • wholeDB: データベース内のすべてのデータ・ファイル。
  • tablespace: 表領域名に関連付けられた1つ以上のデータ・ファイル。
  • datafile: 1つ以上のデータ・ファイル。
  • archivedLog: 個別のログ順序番号の1つのコピー。
  • recoveryFilesOnDisk: 高速リカバリ領域に格納されているか、ディスクの別の場所に格納されているかに関係なく、ディスク上のすべてのリカバリ・ファイル。
  • cdbRoot: コンテナ・ルート全体のデータ・ファイル。
  • pluggableDbs: 1つ以上のプラガブル・データベースのデータ・ファイル。
scopeValue

バックアップする値のカンマ区切りリスト。-scope値がtablespace|datafile|pluggableDbsの場合は必須です。

backupType

バックアップのタイプ。この引数が指定されていない場合、デフォルト値はfullです。指定可能な値:

  • full: バックアップされているデータ・ファイルのすべてのデータ・ブロックをバックアップします。
  • incr0: 増分レベル0。完全バックアップと似ていますが、増分バックアップ計画のベースとして使用できます。
  • incr1: 増分レベル1。変更されたブロックのみをバックアップします。
incrType

増分バックアップのタイプ。-"backupType":"incr"と組み合せて使用します。この引数が指定されていない場合、デフォルト値はdiffです。指定可能な値:

  • diff: 最新のレベル0またはレベル1の増分バックアップ以降に更新されたブロックをバックアップします。
  • cumulative: 最新のレベル0のバックアップ以降に変更されたすべてのブロックをバックアップします。
destinationMedia

このバックアップの宛先メディア。この引数が指定されていない場合、デフォルト値はdiskです。指定可能な値:

  • disk: ディスクへのバックアップ(- scope="recoveryFilesOnDisk"の場合は使用できません)。
  • tape: SBT(テープへのシステム・バックアップ)デバイスへのバックアップ。
  • ra: リカバリ・アプライアンスへのバックアップ。
  • cloud: Database Backup Cloud Serviceへのバックアップ。
backupEncryptionMode

Oracle Encryption Walletまたはユーザー指定のパスワード(あるいは両方)を使用してバックアップを暗号化するために指定します。指定可能な値:

  • wallet: Oracle Encryption Wallet
  • password: ユーザー指定のパスワード
  • both: Oracle Encryption Walletとユーザー指定パスワード

このオプションは、-scope="wholeDB| tablespace|datafile|archivedLog|recoveryFilesOnDisk|cdbRoot| pluggableDbs"の場合に指定できます。
rmanEncryptionCredName

暗号化パスワードを含む既存のEnterprise Manager汎用名前付き資格証明の名前。"backupEncryptionMode":"password"が指定されている場合は必須です。
encryptionAlogrithm

バックアップの暗号化時に使用する暗号化アルゴリズムの名前。"backupEncryptionMode"と組み合せて使用します。設定可能な値は、AES128、AES192およびAES256です。この引数が指定されていない場合、デフォルト値はAES256です。
skipBackupArchivedLogs

バックアップされていないディスク上のすべてのアーカイブ・ログがバックアップされません。この引数を指定しない場合のデフォルトの動作では、バックアップされていないすべてのアーカイブ・ログがバックアップされます。指定可能な値はtrue|falseです。このオプションは、-scope="wholeDb|tablespace|datafile| cdbRoot|pluggableDbs"の場合に指定できます。
delete_Archived_Logs_After_Backup

正常にバックアップされた後で、すべてのアーカイブ・ログをディスクから削除します。「-skip_Backup_Archived_Logs」が指定されている場合は無視されます。使用可能な値は、trueおよびfalseです。

このオプションは、-scope="wholeDB| tablespace|datafile|cdbRoot|pluggableDbs"の場合に指定できます。

deleteObsolateBackups

保存ポリシーを満たすために必要でなくなったバックアップを削除します。指定可能な値はtrue|falseです。このオプションは、-scope="wholeDB|tablespace| datafile|cdbRoot|pluggableDbs"の場合に指定できます。
maxFilesPerSet

1バックアップ・セット当たりの最大ファイル数。このオプションは、-scope="wholeDB| tablespace|datafile|archivedLog|cdbRoot|pluggableDbs"の場合に指定できます。
maxCorruptions

データ・ファイルで許容される物理的な破損の最大数。このオプションは、-scope="datafile"の場合に指定できます。
sectionSize

データ・ファイルのバックアップ時に生成される各バックアップ・セクションのサイズ(MB)。各バックアップ・ピースに1つのファイル・セクションが含まれるマルチセクション・バックアップになります。このオプションは、RMAN構成で「バックアップ・ピースの最大サイズ」が設定されている場合は使用できません。このオプションは、- scope="wholeDB|tablespace|datafile|archivedLog|cdbRoot| pluggableDbs"の場合に指定できます。

cloudAccount

Enterprise ManagerのHybrid Cloud設定コンソールで構成したクラウド・アカウントの名前。Backup Serviceに接続するために必要なすべての情報(サービス名、アイデンティティ・ドメイン、ユーザー名、パスワード、コンテナ(オプション)など)は、このアカウントとそれに関連するBackup Service設定から取得されます。この引数が指定されない場合、Database BackupのCloud Service設定ページで構成したグローバル・クラウド・アカウント設定が使用されます。(この引数を適用できるのは、Hybrid Cloud設定コンソールを使用して、アカウントとBackup Service設定を構成した場合のみです)。

例 - "cloudAccount":"endpoint:https://storage.example.com/ Storageemdev2;identityDomain:xxx;username:xxxx;password:xxxx;contai ner:xxxx"

ファスト・スタート・フェイルオーバーREST API

この章では、Enterprise Managerでサポートされているファスト・スタート・フェイルオーバーおよびオブザーバ向けのREST APIの詳細について説明します。ファスト・スタート・フェイルオーバーが有効になると、プライマリ・サイトで障害が発生した場合、Data Guard Brokerにより、DBAによる操作の必要なしに同期化されたスタンバイ・サイトに自動的にフェイルオーバーされます。また、アプリケーションにロールの推移が自動的に通知されます。

ファスト・スタート・フェイルオーバー管理REST API

ファスト・スタート・フェイルオーバーは、Oracle Data Guard Brokerが、障害が発生したプライマリ・データベースを事前に決定されたスタンバイ・データベースに自動的にフェイルオーバーできるようにする機能です。この機能により、フェイルオーバー・プロセスの一環としてユーザーが関与する必要がなくなるため、データベースの可用性が向上します。

ファスト・スタート・フェイルオーバー管理REST API

表12-9 ファスト・スタート・フェイルオーバー

機能 説明
URL https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/db/dataguard/configure/fsfo
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
本文 
{
    "action" : "<edit | enable | disable| change_mode>",
    "primary" : {
        "dbTargetName" : "<primary database target name>",
        "dbTargetType" : "oracle_database | rac_database",
        "dbCredName" : "<primary database credential name>",
        "dbHostCredName" : "<primary database host credential name>",
        "dbGIHostCredName" : "<grid infrastructure credential name>"

        "dbObserverConnectIdentifier" : "<ObserverConnectIdentifier value of the primary database>",
        "dbFastRecoveryArea" : "<Fast recovery area location of the database - default V$RECOVERY_FILE_DEST>",
        "dbFastRecoveryAreaSize" : "<Fast recovery area size(MB) of the database - default 2x database size>",
        "dbFlashbackRetentionTime" : "<Flashback retention time hours - default 24h>"
    },
    "candidateFSFOTargets" : 
        {
            "dbTargetName" : "<standby database target name>",
            "dbTargetType" : "<oracle_database | rac_database>",
            "dbCredName" : "<standby database credential name>",
            "dbHostCredName" : "<standby database host credential name>",
            "dbGIHostCredName" : "<grid infrastructure credential name>"

            "dbObserverConnectIdentifier" : "<ObserverConnectIdentifier value of the primary database>",
            "dbFastRecoveryArea" : "<Fast recovery area location of the database - default V$RECOVERY_FILE_DEST>",
            "dbFastRecoveryAreaSize" : "<Fast recovery area size(MB) of the database - default 2x database size>",
            "dbFlashbackRetentionTime" : "<Flashback retention time hours - default 24h>"
        },
    "observer" : {
            "name": "<observer name - default is the hostname>",
            "hostName" : "<observer host name>",
            "oracleHome" : "<observer oracle home>",
            "hostCredName" : "<observer host credential name>"
    },
    "alternateObserver" : {
            "hostName" : "<alternate observer host name>",
            "oracleHome" : "<alternate observer oracle home>",
            "hostCredName" : "<alternate observer host credential name>"
    },
    "failoverThreshold" : "<failover threshold>",
    "lagLimit" : "<lag limit>",
    "failoverConditions" : "<failover conditions>",

    "calloutScripts" : {
            "hostName" : "<host name>", 
            "hostCredentials" : "<host credential>"
            "preCallout" : "<path of pre role change callout script>",
            "postCallout" : "<path of post role change callout script>",
            "sucFileName" : "<Name of the suc file that>",
            "errorFileName" : "<Name of the .err file>",
            "fsfoPreCalloutTimeout" : "<Value in seconds>",
            "fsfoActionOnPreCalloutFailure" : "<STOP | CONTINUE>"

        },
    "enableFlashBackDatabase" : "<Yes | No>",
    "autoReinstatePrimary" : "<Yes | No>",
    "autoShutdownPrimary" : "<Yes | No>"
    "observeOnly" : "<Yes | No  - Default Value: No>"
    "includeOraError240" : "<Yes | No  -Default Value: Yes>",
}
無効化の本文 
{
        "action" : "disable",
        ["stopAllObservers" : "<Yes | No - Default value: Yes, applicable only for 'disable' action>"]
        "primary" :  { 
                "dbTargetName" : "<Primary database Enterprise Manager target name>", 
                "dbTargetType" : "oracle_database | rac_database", 
                ["dbCredName" : "<Primary database named credential for a user with SYSDBA or SYSDG role. Default Value: Preferred credential will be used>",] 
                ["dbHostCredName" : "<Primary database host named credential for an operating system user who can access the primary database Oracle home. Default Value: Preferred credential will be used>",] 
                ["dbGIHostCredName" : "<Grid Infrastructure named credentials for an operating system user who can access the grid infrastructure Oracle home of the Primary Database. Default Value: Preferred credential will be used>"] 
         } 
}
変更モードの本文 
{
        "action" : "change_mode",
        "primary" :  { 
                "dbTargetName" : "<Primary database Enterprise Manager target name>", 
                "dbTargetType" : "oracle_database | rac_database", 
                ["dbCredName" : "<Primary database named credential for a user with SYSDBA or SYSDG role. Default Value: Preferred credential will be used>",] 
                ["dbHostCredName" : "<Primary database host named credential for an operating system user who can access the primary database Oracle home. Default Value: Preferred credential will be used>",] 
                ["dbGIHostCredName" : "<Grid Infrastructure named credentials for an operating system user who can access the grid infrastructure Oracle home of the Primary Database. Default Value: Preferred credential will be used>"] 
         } 
}
ノート オブザーバおよび代替オブザーバはオプションです。
リクエスト・メソッド POST
サンプル・レスポンス 
{
    "status" : "Succeeded",
    "submissionName" : "DG_FAST_START_FAIL_OVER_*",
    "executionGUID" : "<execution guid>",
    "databaseName" : "<primary database name>",
    "message" : "Deployment Procedure for configuring fast-start failover of the Data Guard configuration determined from the primary database <primary database name> is successfully submitted."
}
サポート開始リリース EM DB 13.4

表12-10 ファスト・スタート・フェイルオーバー

機能 説明
URL https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/db/dataguard/configure/fsfo
リクエスト・ヘッダー

Authorization: Basic

Content-Type: application/json
本文 
{
    "action" : "<edit | enable | disable| change_mode>",
    "primary" : {
        "dbTargetName" : "<primary database target name>",
        "dbTargetType" : "oracle_database | rac_database",
        "dbCredName" : "<primary database credential name>",
        "dbHostCredName" : "<primary database host credential name>",
        "dbGIHostCredName" : "<grid infrastructure credential name>"

        "dbObserverConnectIdentifier" : "<ObserverConnectIdentifier value of the primary database>",
        "dbFastRecoveryArea" : "<Fast recovery area location of the database - default V$RECOVERY_FILE_DEST>",
        "dbFastRecoveryAreaSize" : "<Fast recovery area size(MB) of the database - default 2x database size>",
        "dbFlashbackRetentionTime" : "<Flashback retention time hours - default 24h>"
    },
    "candidateFSFOTargets" : 
        {
            "dbTargetName" : "<standby database target name>",
            "dbTargetType" : "<oracle_database | rac_database>",
            "dbCredName" : "<standby database credential name>",
            "dbHostCredName" : "<standby database host credential name>",
            "dbGIHostCredName" : "<grid infrastructure credential name>"

            "dbObserverConnectIdentifier" : "<ObserverConnectIdentifier value of the primary database>",
            "dbFastRecoveryArea" : "<Fast recovery area location of the database - default V$RECOVERY_FILE_DEST>",
            "dbFastRecoveryAreaSize" : "<Fast recovery area size(MB) of the database - default 2x database size>",
            "dbFlashbackRetentionTime" : "<Flashback retention time hours - default 24h>"
        },
    "observer" : {
            "name": "<observer name - default is the hostname>",
            "hostName" : "<observer host name>",
            "oracleHome" : "<observer oracle home>",
            "hostCredName" : "<observer host credential name>"
    },
    "alternateObserver" : {
            "hostName" : "<alternate observer host name>",
            "oracleHome" : "<alternate observer oracle home>",
            "hostCredName" : "<alternate observer host credential name>"
    },
    "failoverThreshold" : "<failover threshold>",
    "lagLimit" : "<lag limit>",
    "failoverConditions" : "<failover conditions>",

    "calloutScripts" : {
            "hostName" : "<host name>", 
            "hostCredentials" : "<host credential>"
            "preCallout" : "<path of pre role change callout script>",
            "postCallout" : "<path of post role change callout script>",
            "sucFileName" : "<Name of the suc file that>",
            "errorFileName" : "<Name of the .err file>",
            "fsfoPreCalloutTimeout" : "<Value in seconds>",
            "fsfoActionOnPreCalloutFailure" : "<STOP | CONTINUE>"

        },
    "enableFlashBackDatabase" : "<Yes | No>",
    "autoReinstatePrimary" : "<Yes | No>",
    "autoShutdownPrimary" : "<Yes | No>"
    "observeOnly" : "<Yes | No  - Default Value: No>"
    "includeOraError240" : "<Yes | No  -Default Value: Yes>",
}
ノート オブザーバおよび代替オブザーバはオプションです。
リクエスト・メソッド POST
サンプル・レスポンス 
{
    "status" : "Succeeded",
    "submissionName" : "DG_FAST_START_FAIL_OVER_*",
    "executionGUID" : "<execution guid>",
    "databaseName" : "<primary database name>",
    "message" : "Deployment Procedure for configuring fast-start failover of the Data Guard configuration determined from the primary database <primary database name> is successfully submitted."
}
サポート開始リリース EM DB 13.4

ファスト・スタート・フェイルオーバーのパラメータ

パラメータ 説明 必須 値 | デフォルト値
action ファスト・スタート・フェイルオーバー構成で実行される操作。
  • enable: ファスト・スタート・フェイルオーバーを使用可能にします。
  • disable: ファスト・スタート・フェイルオーバーを無効にしてオブザーバを停止します。
  • edit: ファスト・スタート・フェイルオーバーのターゲット・データベースおよびしきい値を変更して、オブザーバ・プロセスを起動または再起動します。
必須 edit | enable | disable
dbTargetName プライマリ・データベースまたはスタンバイ・データベースのEnterprise Managerターゲット名。 必須 該当なし
dbTargetType プライマリ・データベースまたはスタンバイ・データベースのターゲット・タイプ。 必須 oracle_database | rac_database
dbCredName SYSDBAまたはSYSDGロールを持つユーザーのプライマリ・データベースまたはスタンバイ・データベースの名前付き資格証明。 オプション 優先資格証明が使用されます。
dbHostCredName データベースのOracleホームにアクセスできるオペレーティング・システム・ユーザーのプライマリ・データベースまたはスタンバイ・データベースのホストの名前付き資格証明。 オプション 優先資格証明が使用されます。
dbGIHostCredName データベースのグリッド・インフラストラクチャOracleホームにアクセスできるオペレーティング・システム・ユーザーのグリッド・インフラストラクチャの名前付き資格証明。 オプション 該当なし
hostName Enterprise Managerがオブザーバまたは代替オブザーバを開始する、検出されたホスト。 必須 該当なし
oracleHome Enterprise Managerがオブザーバまたは代替オブザーバを開始する、オブザーバ・ホストまたは代替ホスト上のOracleホーム(hostNameで指定)。 必須 該当なし
observer プライマリ・データベースおよびターゲット・スタンバイ・データベースを継続的に監視し、フェイルオーバーの必要性を評価して、選択された条件が発生したときにファスト・スタート・フェイルオーバーを開始するDGMGRL (Data Guardコマンドライン・インタフェース)クライアント。 必須 該当なし
alternateObserver Enterprise Managerでは、以前のホストでオブザーバ・プロセスに障害が発生したことが検出された場合、別のホスト上の代替オブザーバの自動再起動がサポートされます。 必須 該当なし
hostCredName オブザーバのOracleホームにアクセスできるオペレーティング・システム・ユーザーのオブザーバまたは代替オブザーバのホストの名前付き資格証明。 必須 該当なし
failoverThreshold ファスト・スタート・フェイルオーバーの開始前に、プライマリ・データベースがオブザーバおよびスタンバイ・データベースとの接続を解除する必要のある時間(秒)。 オプション 30秒。
lagLimit スタンバイ・データベースがプライマリ・データベースより遅れても可能な時間(秒)。この時間を超えるとファスト・スタート・フェイルオーバーを使用できません。 オプション 30秒。
failoverConditions プライマリ・データベースで検出された場合に、ファスト・スタート・フェイルオーバーを引き起こすフェイルオーバー条件のカンマ区切りリスト。
  • 1 - 破損した制御ファイル
  • 2 - 破損したディクショナリ
  • 3 - アクセス不可能なログ・ファイル
  • 4 - スタック・アーカイバ
  • 5 - データファイル・オフライン
 オプション 1, 2, 5
autoReinstatePrimary プライマリ・データベースが分離またはクラッシュしたためにファスト・スタート・フェイルオーバーが開始した場合に、元のプライマリ・データベースが自動的に回復されます。 オプション Yes | No デフォルト: Yes
autoShutdownPrimary ファスト・スタート・フェイルオーバーが有効にされている場合、プライマリ・データベースを自動的に停止します。 オプション Yes | No
dbObserverConnectIdentifier プライマリ・データベースのObserverConnectIdentifier構成可能プロパティ値 オプション 該当なし
dbFastRecoveryArea データベースの高速リカバリ領域の場所 オプション V$RECOVERY_FILE_DEST
dbFastRecoveryAreaSize データベースの高速リカバリ領域のサイズ(MB) オプション データベース・サイズの2倍
dbFlashbackRetentionTime フラッシュバック保存時間(時間数) オプション 24時間
name オブザーバの名前 オプション hostname
hostName ロール変更前およびロール変更後コールアウト・スクリプトを含むホストのホスト名 オプション 該当なし
hostCredentials ロール変更前およびロール変更後コールアウト・スクリプトを含むホストのホスト資格証明名 オプション 該当なし
preCallout ロール変更前コールアウト・スクリプトのフル・パス オプション 該当なし
postCallout ロール変更後コールアウト・スクリプトのフル・パス オプション 該当なし
sucFileName 事前コールアウト・スクリプトで作成される成功(.suc)ファイルの名前 オプション precallout.suc
errorFileName 事前コールアウト・スクリプトで作成されるエラー(.err)ファイルの名前 オプション precallout.err
fsfoPreCalloutTimeout コールアウトのタイムアウト(秒単位で表した数値) オプション 600秒
fsfoActionOnPreCalloutFailure 失敗した場合の事前コールアウト・アクション。STOPまたはCONTINUE オプション STOP | CONTINUE

デフォルト: Top
enableFlashBackDatabase データベースのフラッシュバックを有効にします。 オプション YES|NOデフォルト: NO
observeOnly フェイルオーバーのみを監視します オプション YES|NOデフォルト: NO

オブザーバ管理REST API

ノート:

このREST APIは、Oracle Databaseバージョン12.2以上に適用できます。

Data Guard構成のための複数オブザーバの構成

表12-11 オブザーバの起動

機能 説明

URL

https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/db/dataguard/configure/observers

リクエスト・ヘッダー

Authorization: basic

Content-Type: application/json

本文

 
{
    "action" : "<start | stop | setMaster | show | delete_alternate_observer | stopall | editCallout | removeCallout>",
    "primary" : {
        "dbTargetName" : "<Primary database Enterprise Manager target name>",
        "dbTargetType" : "oracle_database | rac_database",
        ["dbCredName" : "<Primary database named credential for a user with SYSDBA role. Default Value: Preferred credentials will be used>",]
        ["dbHostCredName" : "<Primary database host named credential for an operating system user who can access the primary database Oracle home. Default Value: Preferred credentials will be used.>"]
    },
    "observers" : [
        {
            "name" : "<Observer name>",
            "hostName" : "<Host name where observer will be started>",
            "oracleHome" : "<Oracle home location on the host where observer will be started>",
            "hostCredName" : "<Host named credential for user who can access the observer Oracle home>",
            "hostWalletCredName" : "<Named credential of the Oracle wallet configured in the observer Oracle home>",
            ["isMaster" : "<Y|N>",]
            ["runTimeDataFile" : "<Runtime data file path and name for the observer. If not specified, the file fsfo.dat will be created under the oracle base>",]
            ["logFile" : "<The full path of the observer log file>"]
        },
        {
            ...
        },
        {
            ...
        }
    ]

    ["calloutScripts" : {
            "hostName" : "<Name of the host containing the pre and post role change callout scripts>", 
            "hostCredentials" : "<Credential name of the host containing pre and post role change callout scripts>"
            "preCallout" : "<Absolute path of pre role change callout script on the hostName>",
            "postCallout" : "<Absolute path of post role change callout script on the hostName>",
            "sucFileName" : "<Name of the suc file that the precallout script would create on the observer host | Default - precallout.suc>",
            "errorFileName" : "<Name of the err file that the precallout script would create on the observer host | Default - precallout.err>",
            "fsfoPreCalloutTimeout" : "<Numeric value in seconds of the time for whic the observer will wait for the suc/err file to be generated, default value - 600>",
            "fsfoActionOnPreCalloutFailure" : "<Action that indicates what the observer will do if the suc file does not exist even if after FastStartFailoverPreCalloutTimeout seconds, or the error file is detected before FastStartFailoverPreCalloutTimeout seconds passed. Initiate the failover - CONTINUE, or not do failover - STOP. Values - STOP | CONTINUE, default value - STOP>"

        },
    ]

}
起動の本文 
{
    "action" : "start",
    "primary" : {
        "dbTargetName" : "<Primary database Enterprise Manager target name>",
        "dbTargetType" : "oracle_database | rac_database",
        ["dbCredName" : "<Primary database named credential for a user with SYSDBA or SYSDG role. Default Value: Preferred credentials will be used>",]
        ["dbHostCredName" : "<Primary database host named credential for an operating system user who can access the primary database Oracle home. Default Value: Preferred credentials will be used.>"]
    },
    "observers" : [
        {
            "name" : "<Observer name>",
            "hostName" : "<Host name where observer will be started>",
            "oracleHome" : "<Oracle home location on the host where observer will be started>",
            "hostCredName" : "<Host named credential for user who can access the observer Oracle home>",
            "hostWalletCredName" : "<Named credential of the Oracle wallet configured in the observer Oracle home>",
            ["isMaster" : "<Y|N>",]
            ["runTimeDataFile" : "<Runtime data file path and name for the observer. If not specified, the file fsfo.dat will be created under the oracle base>",]
            ["logFile" : "<The full path of the observer log file>"]
        },
        {
            ...
        },
        {
            ...
        }
    ]
    ["calloutScripts" : {
            "hostName" : "<Name of the host containing the pre and post role change callout scripts>", 
            "hostCredentials" : "<Credential name of the host containing pre and post role change callout scripts>"
            "preCallout" : "<Absolute path of pre role change callout script on the hostName>",
            "postCallout" : "<Absolute path of post role change callout script on the hostName>",
            "sucFileName" : "<Name of the suc file that the precallout script would create on the observer host | Default - precallout.suc>",
            "errorFileName" : "<Name of the err file that the precallout script would create on the observer host | Default - precallout.err>",
            "fsfoPreCalloutTimeout" : "<Numeric value in seconds of the time for whic the observer will wait for the suc/err file to be generated, default value - 600>",
            "fsfoActionOnPreCalloutFailure" : "<Action that indicates what the observer will do if the suc file does not exist even if after FastStartFailoverPreCalloutTimeout seconds, or the error file is detected before FastStartFailoverPreCalloutTimeout seconds passed. Initiate the failover - CONTINUE, or not do failover - STOP. Values - STOP | CONTINUE, default value - STOP>"
 
        },
    ]
}
停止の本文 
{
    "action" : "stop",
    "primary" : {
        "dbTargetName" : "<Primary database Enterprise Manager target name>",
        "dbTargetType" : "oracle_database | rac_database",
        ["dbCredName" : "<Primary database named credential for a user with SYSDBA or SYSDG role. Default Value: Preferred credentials will be used>",]
        ["dbHostCredName" : "<Primary database host named credential for an operating system user who can access the primary database Oracle home. Default Value: Preferred credentials will be used.>"]
    }
    "observers" : [
        {"name" : "<observer 1 name>"},
        {"name" : "<observer 2 name>"},
        {"name" : "<observer 3 name>"}
    ]
}
マスターの設定の本文 
{
    "action" : "setMaster",
    "primary" : {
        "dbTargetName" : "<Primary database Enterprise Manager target name>",
        "dbTargetType" : "oracle_database | rac_database",
        ["dbCredName" : "<Primary database named credential for a user with SYSDBA or SYSDG role. Default Value: Preferred credentials will be used>",]
        ["dbHostCredName" : "<Primary database host named credential for an operating system user who can access the primary database Oracle home. Default Value: Preferred credentials will be used.>"]
    }
    "masterObserver" : "<master observer name>"
}
すべて表示およびすべて停止の本文 
{
    "action" : "show | stopall",
    "primary" : {
        "dbTargetName" : "<Primary database Enterprise Manager target name>",
        "dbTargetType" : "oracle_database | rac_database",
        ["dbCredName" : "<Primary database named credential for a user with SYSDBA or SYSDG role. Default Value: Preferred credentials will be used>",]
        ["dbHostCredName" : "<Primary database host named credential for an operating system user who can access the primary database Oracle home. Default Value: Preferred credentials will be used.>"]
    }
}
コールアウトの編集の本文 
{
    "action" : "editCallout",
    "primary" : {
        "dbTargetName" : "<Primary database Enterprise Manager target name>",
        "dbTargetType" : "oracle_database | rac_database",
        ["dbCredName" : "<Primary database named credential for a user with SYSDBA or SYSDG role. Default Value: Preferred credentials will be used>",]
        ["dbHostCredName" : "<Primary database host named credential for an operating system user who can access the primary database Oracle home. Default Value: Preferred credentials will be used.>"]
    }    
    ["calloutScripts" : {
            "hostName" : "<Name of the host containing the pre and post role change callout scripts>", 
            "hostCredentials" : "<Credential name of the host containing pre and post role change callout scripts>"
            "preCallout" : "<Absolute path of pre role change callout script on the hostName>",
            "postCallout" : "<Absolute path of post role change callout script on the hostName>",
            "sucFileName" : "<Name of the suc file that the precallout script would create on the observer host | Default - precallout.suc>",
            "errorFileName" : "<Name of the err file that the precallout script would create on the observer host | Default - precallout.err>",
            "fsfoPreCalloutTimeout" : "<Numeric value in seconds of the time for whic the observer will wait for the suc/err file to be generated, default value - 600>",
            "fsfoActionOnPreCalloutFailure" : "<Action that indicates what the observer will do if the suc file does not exist even if after FastStartFailoverPreCalloutTimeout seconds, or the error file is detected before FastStartFailoverPreCalloutTimeout seconds passed. Initiate the failover - CONTINUE, or not do failover - STOP. Values - STOP | CONTINUE, default value - STOP>"
 
        },
    ]
}
コールアウトの削除の本文 
{
    "action" : "removeCallout",
    "primary" : {
        "dbTargetName" : "<Primary database Enterprise Manager target name>",
        "dbTargetType" : "oracle_database | rac_database",
        ["dbCredName" : "<Primary database named credential for a user with SYSDBA or SYSDG role. Default Value: Preferred credentials will be used>",]
        ["dbHostCredName" : "<Primary database host named credential for an operating system user who can access the primary database Oracle home. Default Value: Preferred credentials will be used.>"]
    },
     "observers" : [
        {
            "name" : "<Observer name>",
            "hostName" : "<Host name where observer will be started>",
            "oracleHome" : "<Oracle home location on the host where observer will be started>",
            "hostCredName" : "<Host named credential for user who can access the observer Oracle home>"
        },
        {
            ...
        },
        {
            ...
        }
    ] 
}
ノート 最大3つのオブザーバを割り当てることができます。

サンプル・レスポンス

 
{
    "status" : "Succeeded",
    "submissionName": "ConfigureObserver_*",
    "executionGUID" : "<execution guid>",
    "databaseName" : "<primary database name>",
    "message" : "Deployment procedure to start the observer(s) for the Data Guard Configuration associated with the primary database <primary database name> is successfully submitted."
                 
}

リクエスト・メソッド

POST

サポート開始リリース

EM DB 13.4

表12-12 すべてのオブザーバの削除、表示または停止

機能 説明

URL

https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/db/dataguard/configure/observers

リクエスト・ヘッダー

Authorization: basic

Content-Type: application/json

本文

 
{
    "action" : "<delete_alternate_observer | show | stopall>",
    "primary" : {
        "dbTargetName" : "<primary database target name>",
        "dbTargetType" : "oracle_database | rac_database",
        "dbCredName" : "<primary database credential name>",
        "dbHostCredName" : "<primary database host credential name>"
    }
}

サンプル・レスポンス

表示

{
    "status": "Succeeded",
    "submissionName" : "ShowObserver_*",
    "executionGUID" : "<execution guid>",
    "databaseName" : "<primary database name>",
    "message" : "Deployment procedure to list the observer(s) for the Data Guard Configuration associated with the primary database <primary database name> is successfully submitted."
}

代替オブザーバの削除

{
    "status" : "Succeeded",
    "submissionName" : "DeleteAlternateObserver_*",
    "executionGUID" : "<execution guid>",
    "databaseName" : "<primary database name>",
    "message" : "Deployment procedure to delete the alternate observer for the Data Guard Configuration associated with the primary database <primary database name> is successfully submitted."
}

すべて停止

{
    "status" : "Succeeded",
    "submissionName" : "StopObserver_*",
    "executionGUID" : "<execution guid>",
    "databaseName" : "<primary database name>",
    "message" : "Deployment procedure to stop the observer(s) for the Data Guard Configuration associated with the primary database <primary database name> is successfully submitted."
}

リクエスト・メソッド

POST

サポート開始リリース

EM DB 13.4

表12-13 オブザーバの停止

機能 説明

URL

https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/db/dataguard/configure/observers

リクエスト・ヘッダー

Authorization: basic

Content-Type: application/json

本文

 
{
    "action" : "stop",
    "primary" : {
        "dbTargetName" : "<primary database target name>",
        "dbTargetType" : "oracle_database | rac_database",
        "dbCredName" : "<primary database credential name>",
        "dbHostCredName" : "<primary database host credential name>"
    }
    "observers" : [
        {"name" : "<observer 1 name>"},
        {"name" : "<observer 2 name>"},
        {"name" : "<observer 3 name>"}
    ]
}

サンプル・レスポンス

 
{
    "status" : "Succeeded",
    "submissionName": "StopObserver_*",
    "executionGUID" : "<execution guid>",
    "databaseName" : "<primary database name>",
    "message" : "Deployment procedure to stop the observer(s) for the Data Guard Configuration associated with the primary database <primary database name> is successfully submitted."
}

リクエスト・メソッド

POST

サポート開始リリース

EM DB 13.4

表12-14 マスター・オブザーバの設定

機能 説明

URL

https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/db/dataguard/configure/observers

リクエスト・ヘッダー

Authorization: basic

Content-Type: application/json

本文

 
{
    "action" : "setMaster",
    "primary" : {
        "dbTargetName" : "<primary database target name>",
        "dbTargetType" : "oracle_database | rac_database",
        "dbCredName" : "<primary database credential name>",
        "dbHostCredName" : "<primary database host credential name>"
    }
    "masterObserver" : "<master observer name>"
}

サンプル・レスポンス

 
{
    "status" : "Succeeded",
    "submissionName": "SetMasterObserver_*",
    "executionGUID" : "<execution guid>",
    "databaseName" : "<primary database name>",
    "message" : "Deployment procedure to set the master observer for the Data Guard Configuration associated with the primary database <primary database name> is successfully submitted."
}

リクエスト・メソッド

POST

サポート開始リリース

EM DB 13.4

表12-15 オブザーバのパラメータ

パラメータ 説明 必須 値 | デフォルト値
action
APIが実行するアクション。すべての操作は相互に排他的です。これらは結合できないため、個別に実行する必要があります。
  • start: 指定したプライマリ・データベースに関連付けられているData Guard構成の指定したホストおよびOracleホームで、1つ以上のファスト・スタート・フェイルオーバー・オブザーバを起動します。
  • delete_alternate_observer: Enterprise Managerの代替オブザーバおよび関連する修正処理ジョブを削除します。Enterprise Managerの代替オブザーバ機能は、Oracle Databaseバージョン12.2以上ではサポートされていません。
  • show: 指定したプライマリ・データベースに関連付けられているData Guard構成用に構成されているオブザーバのリストを表示します。
  • stop: 指定したプライマリ・データベースに関連付けられているData Guard構成に対応するオブザーバを停止します。
  • stopall: すべてのオブザーバを停止します。
  • setMaster: 指定したプライマリ・データベースに関連付けられているData Guard構成のマスター・オブザーバを構成します。
必須 start | delete_alternate_observer | show | stop | stopall | setMaster
dbTargetName プライマリ・データベースのEnterprise Managerターゲット名。 必須 該当なし
dbTargetType

プライマリ・データベースのターゲット・タイプ。

 必須 oracle_database | rac_database
dbCredName

SYSDBAまたはSYSDGロールを持つユーザーのプライマリ・データベースの名前付き資格証明。

 [オプション] 優先資格証明が使用されます。
dbHostCredName

プライマリ・データベースのOracleホームにアクセスできるオペレーティング・システム・ユーザーのプライマリ・データベース・ホストの名前付き資格証明。

[オプション] 優先資格証明が使用されます。
name オブザーバ名。 必須 該当なし
hostName オブザーバを起動するホスト名。 必須 該当なし
oracleHome オブザーバが起動されるホスト上のOracleホームの場所。 必須 該当なし
hostCredName オブザーバのOracleホームにアクセスできるユーザーのホストの名前付き資格証明。 必須 該当なし
hostWalletCredName オブザーバのOracleホームに構成されているOracleウォレットの名前付き資格証明。 必須 該当なし
isMaster

オブザーバがマスターかどうかを定義します。

 [オプション] Y | N
masterObserver

マスター・オブザーバの設定に必要

マスター・オブザーバを定義します。

 [オプション] 該当なし
runTimeDataFile

オブザーバのランタイム・データ・ファイルのパスと名前。指定しない場合、ファイルfsfo.datがOracleベースに作成されます。

 [オプション] 該当なし
logFile

オブザーバ・ログ・ファイルのフルパス。

 [オプション] 該当なし
hostName ロール変更前およびロール変更後コールアウト・スクリプトを含むホストのホスト名 オプション 該当なし
hostCredentials ロール変更前およびロール変更後コールアウト・スクリプトを含むホストのホスト資格証明名 オプション 該当なし
preCallout ロール変更前コールアウト・スクリプトのフル・パス オプション 該当なし
postCallout ロール変更後コールアウト・スクリプトのフル・パス オプション 該当なし
sucFileName 事前コールアウト・スクリプトで作成される成功(.suc)ファイルの名前 オプション precallout.suc
errorFileName 事前コールアウト・スクリプトで作成されるエラー(.err)ファイルの名前 オプション precallout.err
fsfoPreCalloutTimeout コールアウトのタイムアウト(秒単位で表した数値) オプション 600秒
fsfoActionOnPreCalloutFailure 失敗した場合の事前コールアウト・アクション。STOPまたはCONTINUE オプション STOP | CONTINUE

デフォルト: Top