GIMR REST API

GIMRを使用するEnterprise Manager環境のREST APIの例。

GIMRターゲットのサブスクライブ

機能 説明
リクエスト・メソッド POST
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/goldimage/imagesubscriptions
リクエスト・ヘッダー

Authorization: Basic

Accept: application/json
ペイロード 
{
    "imageId":"C672F6FC600B2484E0532D8145648320",
    "targetList":"example-cluster",
    "targetType":"oracle_database",
    "gimr":"true"
}
レスポンス 
Targets 'example-cluster' subscribed successfully.

入力変数の説明

  • imageID: イメージのGUID番号。
  • targetList: パッチを適用するクラスタ・ターゲットのカンマ区切りリスト。
  • targetType: エンティティ・タイプに基づくCLIコマンド入力の表を参照してください。
  • gimr: ターゲットがクラスタ・データベースかどうかを判別します(trueに設定した場合)。

GIMRターゲットのデプロイ

機能 説明
リクエスト・メソッド POST
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/fleetmaintenance/performOperation/deploy
リクエスト・ヘッダー

Authorization: Basic

Accept: application/json
ペイロード

ノート:

18c/19cから21c以上へのGIMRアップグレードでは、グループの入力が必須です。21cから以降のバージョンへのGIMR更新/アップグレードの場合、グループの詳細はオプションです。 
{
	"name": "Deploy GIMR Home",
	"targetName" : "sample-cluster",
	"targetType" : "cluster",
	"normalCredString" : "USER:SYSMAN",
	"privCredString" : "ROOT:SYSMAN",
	"skipCVUChecks" : "true",
	"skipPrereqs" : "true",
	"newOracleHomeLoc" : "/scratch/cuser/app/grid_home/21.0.0.0",
	"gimr":"true",
	"gimrOsDbaGroup":"oinstall",
	"gimrOsOperGroup":"oinstall",
	"gimrOsBackupDbaGroup":"oinstall",
	"gimrOsDgDbaGroup":"oinstall",
	"gimrOsKmDbaGroup":"oinstall",
	"gimrOsRacDbaGroup":"oinstall",
	"gimrOsInstallGroup":"oinstall"
}
レスポンス 
Processing target: sample-cluster
Current CRS Location: /scratch/cuser/app/grid_home/18.3.0/grid_home_18
Current CRS Location: /scratch/cuser/app/grid_home/18.3.0/grid_home_18
Current GIMR Location: /scratch/cuser/app/grid_home/18.3.0/grid_home_18
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Oracle home target list is 985127A8E0D0E0CE8EC38C07A219E43D,243BC04B4F5FCBF20FE9B8030B5F481F
Operation 'Deploy GIMR Home' created successfully.
Deploy Oracle home software operation for GIMR target example-cluster can be monitored using

Browser:

 https://blr123.example.com:24503/em/faces/core-jobs-procedureExecutionTracking?executionGUID=CAC614657A9544A2E0532D81456439DA

Status:Success

入力変数の説明

  • name: 操作の名前。
  • targetName: ターゲットの名前。
  • targetType: エンティティ・タイプに基づくCLIコマンド入力の表を参照してください。
  • normalCredString: これは<Named Credential: Credential Owner>という形式で入力する必要があります。
    • <Named Credential>: 新しいOracleホームがデプロイされるホストの名前付き資格証明。
    • <Credential Owner>: この名前付き資格証明を所有するEnterprise Managerユーザー。
  • privCredString: これは<Named Credential: Credential Owner>という形式で入力する必要があります。
    • <Named Credential>: 新しいOracleホームがデプロイされるホストの名前付き資格証明。
    • <Credential Owner>: この名前付き資格証明を所有するEnterprise Managerユーザー。

    これらの資格証明は、スクリプトをルートとして実行するために使用されます。

  • skipCVUChecks: true|false。デフォルト値はfalse
  • skipPrereqs: true|false。デフォルト値はfalse
  • gimr: ターゲットがクラスタ・データベースかどうかを判別します(trueに設定した場合)。
  • newOracleHomeLoc: <Oracleホームが作成される場所
  • gimrOsDbaGroup: ターゲット・デプロイメントの必須(GIMRのみ)グループ。
  • gimrOsOperGroup: ターゲット・デプロイメントの必須(GIMRのみ)グループ。
  • gimrOsBackupDbaGroup: ターゲット・デプロイメントの必須(GIMRのみ)グループ。
  • gimrOsDgDbaGroup: ターゲット・デプロイメントの必須(GIMRのみ)グループ。
  • gimrOsKmDbaGroup: ターゲット・デプロイメントの必須(GIMRのみ)グループ。
  • gimrOsRacDbaGroup: ターゲット・デプロイメントの必須(GIMRのみ)グループ。
  • gimrOsInstallGroup: ターゲット・デプロイメントの必須(GIMRのみ)グループ。

GIMRターゲットの更新

機能 説明
リクエスト・メソッド POST
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/fleetmaintenance/performOperation/update
リクエスト・ヘッダー

Authorization: Basic

Accept: application/json
ペイロード 
{
"name": "Update GIMR",
"targetName" : "example-cluster",
"targetType" : "cluster",
"normalCredString" : "USER:SYSMAN",
"privCredString" : "ROOT:SYSMAN",
"gimrOperation":"UPDATE_GIMR"
}
レスポンス 
Checking if target is already running from the current version of the image...
Check Passed.
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Update GIMR' created successfully.
Update operation for GIMR target <example-cluster> can be monitored using:
Browser:
  https://blr123.example.com::24503/em/faces/core-jobs-procedureExecutionTracking?executionGUID=C676BD33103F4FD3E0532D81456424F3

入力変数の説明

  • name: 操作の名前。
  • targetName: ターゲットの名前。
  • targetType: エンティティ・タイプに基づくCLIコマンド入力の表を参照してください。
  • normalCredString: これは<Named Credential: Credential Owner>という形式で入力する必要があります。
    • <Named Credential>: 新しいOracleホームがデプロイされるホストの名前付き資格証明。
    • <Credential Owner>: この名前付き資格証明を所有するEnterprise Managerユーザー。
  • privCredString: これは<Named Credential: Credential Owner>という形式で入力する必要があります。
    • <Named Credential>: 新しいOracleホームがデプロイされるホストの名前付き資格証明。
    • <Credential Owner>: この名前付き資格証明を所有するEnterprise Managerユーザー。

    これらの資格証明は、スクリプトをルートとして実行するために使用されます。

  • gimrOperation: 実行するGIMR操作のタイプ。

GIMRターゲットのアップグレード

機能 説明
リクエスト・メソッド POST
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/fleetmaintenance/performOperation/update
リクエスト・ヘッダー

Authorization: Basic

Accept: application/json
ペイロード 
{
"name": "Upgrade GIMR",
"targetName" : "example-cluster",
"targetType" : "cluster",
"normalCredString" : "USER:SYSMAN",
"privCredString" : "ROOT:SYSMAN",
"gimrOperation":"UPGRADE_GIMR"
}
レスポンス 
Checking if target is already running from the current version of the image...
Check Passed.
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Upgrade GIMR' created successfully.
Upgrade operation for GIMR target <example-cluster> can be monitored using:
Browser:
  https://blr123.example.com::24503/em/faces/core-jobs-procedureExecutionTracking?executionGUID=C676BD33103F4FD3E0532D81456424F3

入力変数の説明

  • name: 操作の名前。
  • targetName: ターゲットの名前。
  • targetType: エンティティ・タイプに基づくCLIコマンド入力の表を参照してください。
  • normalCredString: これは<Named Credential: Credential Owner>という形式で入力する必要があります。
    • <Named Credential>: 新しいOracleホームがデプロイされるホストの名前付き資格証明。
    • <Credential Owner>: この名前付き資格証明を所有するEnterprise Managerユーザー。
  • privCredString: これは<Named Credential: Credential Owner>という形式で入力する必要があります。
    • <Named Credential>: 新しいOracleホームがデプロイされるホストの名前付き資格証明。
    • <Credential Owner>: この名前付き資格証明を所有するEnterprise Managerユーザー。

    これらの資格証明は、スクリプトをルートとして実行するために使用されます。

  • gimrOperation: 実行するGIMR操作のタイプ。

GIMRのロールバック

機能 説明
リクエスト・メソッド POST
URI https://<OMS_CONSOLE_HOST>:OMS_CONSOLE_PORT>/em/websvcs/restful/emws/db/fleetmaintenance/performOperation/rollback
リクエスト・ヘッダー

Authorization: Basic

Accept: application/json
ペイロード 
{
	"name": "Rollback GIMR",
	"targetName" : "example-cluster",
	"targetType" : "cluster",
	"normalCredString" : "USER:SYSMAN",
	"privCredString" : "ROOT:SYSMAN",
	"gimrOperation":"ROLLBACK_GIMR"
}
レスポンス 
CChecking if target is already running from the current version of the image...
Check Passed.
Checking image subscription...
Check image subscription passed.
Checking if target is in non-default location inside the Oracle Home...
Operation 'Rollback GIMR' created successfully.
Update operation for GIMR target <example-cluster> can be monitored using:
Browser:
  https://blr123.example.com::24503/em/faces/core-jobs-procedureExecutionTracking?executionGUID=C676BD33103F4FD3E0532D81456424F3

入力変数の説明

  • name: 操作の名前。
  • targetName: ターゲットの名前。
  • targetType: エンティティ・タイプに基づくCLIコマンド入力の表を参照してください。
  • normalCredString: これは<Named Credential: Credential Owner>という形式で入力する必要があります。
    • <Named Credential>: 新しいOracleホームがデプロイされるホストの名前付き資格証明。
    • <Credential Owner>: この名前付き資格証明を所有するEnterprise Managerユーザー。
  • privCredString: これは<Named Credential: Credential Owner>という形式で入力する必要があります。
    • <Named Credential>: 新しいOracleホームがデプロイされるホストの名前付き資格証明。
    • <Credential Owner>: この名前付き資格証明を所有するEnterprise Managerユーザー。

    これらの資格証明は、スクリプトをルートとして実行するために使用されます。

  • gimrOperation: 実行するGIMR操作のタイプ。