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

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

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

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

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

表16-1 ファスト・スタート・フェイルオーバー

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

Authorization: Basic

Content-Type: application/json
本文 
{
    "action" : "<edit | enable | disable>",
    "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>"
    },
    "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>"
        }],
    "observer" : {
            "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>",
    "autoReinstatePrimary" : "Yes | No",
    "autoShutdownPrimary" : "Yes | No"
}
ノート オブザーバおよび代替オブザーバはオプションです。
リクエスト・メソッド 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で指定)。 必須 該当なし
オブザーバ プライマリ・データベースおよびターゲット・スタンバイ・データベースを継続的に監視し、フェイルオーバーの必要性を評価して、選択された条件が発生したときにファスト・スタート・フェイルオーバーを開始する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

オブザーバ管理REST API

ノート:

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

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

表16-2 オブザーバの起動

機能 説明

URL

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

リクエスト・ヘッダー

Authorization: basic

Content-Type: application/json

本文

 
{
    "action" : "start",
    "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 name>",
            "hostName" : "<host name>",
            "oracleHome" : "<oracle home location>",
            "hostCredName" : "<host credential name>",
            "hostWalletCredName" : "<oracle wallet credential name>",
            "isMaster" : "Y | N",
            "runTimeDataFile" : "<runtime data file path>",
            "logFile" : "<observer log file path>"
        }
    ]
}
ノート 最大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

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

機能 説明

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

表16-4 オブザーバの停止

機能 説明

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

表16-5 マスター・オブザーバの設定

機能 説明

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

表16-6 オブザーバのパラメータ

パラメータ 説明 必須 値 | デフォルト値
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

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

 [オプション]