フリート・パッチ適用およびプロビジョニング用のREST API

Grid Infrastructureソフトウェア・ホームのアップグレード

PUT

/rhp-restapi/rhp/workingcopies/{workingCopyId}/gihome/{destWcId}

Oracle Grid Infrastructureをソース作業用コピーから宛先作業用コピーにアップグレードします。

リクエスト

サポートされるメディア・タイプ

application/json

パス・パラメータ

destWcId(必須): string

Oracleソフトウェアを移動する必要がある宛先作業用コピーの名前
workingCopyId(必須): string

作業用コピーの名前。

ルート・スキーマ: UpgradeGihomeBody

タイプ: object

ソースの表示

abort: boolean

デフォルト値: false

進行中の操作を中止します。
auth: string

認証プラグインを使用してリモート・ノードにアクセスします。
authArgs: object authArgs

使用可能なその他のプロパティ: additionalProperties

選択した認証プラグインの追加プロパティ。
batches: string

"(nA,nB,...),(...,nY,nZ)"の書式で二重引用符("")で囲んだノードのバッチのカンマ区切りリスト(各バッチがカッコで囲まれたノード名のカンマ区切りリストになる)。
continue: boolean

デフォルト値: false

ノードの次のバッチのアップグレードを続行します。
destwc: string

Oracle Grid Infrastructureホームをアップグレードする必要がある宛先作業用コピーの名前。
eval: boolean

デフォルト値: false

コマンドを実行せずに評価します。
gimrwc: string

Grid Infrastructure Management Repositoryデータベースをアップグレードする必要のあるアップグレード先作業用コピーの名前。
ignoreprereq: boolean

デフォルト値: false

CVUの前提条件チェックを無視する場合。
imageName: string

構成済イメージのイメージ名。
path: string

宛先作業用コピーの絶対パス。
revert: boolean

デフォルト値: false

Oracle Grid Infrastructureのアップグレードが失敗した後、ダウングレードします。
root: boolean

デフォルト値: false

ルート資格証明を使用してリモート・ノードにアクセスします。
schedule: string

ISO-8601形式の操作を実行する優先時間。たとえば: 2016-12-21T19:13:17+05.
sourceHome: string

ソースOracleホーム・パス
sourcewc: string

Oracle Grid Infrastructureホームをアップグレードする必要があるソースの作業用コピーの名前。
sudoPath: string

sudoバイナリの場所。
sudoUser: string

sudoユーザー名としてスーパーユーザー操作を実行します。
superUserPasswd: string

スーパーユーザー・アカウントのパスワード。
targetNode: string

高速ホーム・プロビジョニング・クライアントを持たないリモート・クラスタ内のノードの名前。

{
    "type":"object",
    "properties":{
        "sourcewc":{
            "type":"string",
            "description":"Name of the source working copy from which the Oracle Grid Infrastructure needs to be upgraded."
        },
        "destwc":{
            "type":"string",
            "description":"Name of the destination working copy to which the Oracle Grid Infrastructure needs to be upgraded."
        },
        "imageName":{
            "type":"string",
            "description":"Image name from the configured images."
        },
        "targetNode":{
            "type":"string",
            "description":"Name of a node in a remote cluster with no Rapid Home Provisioning Client."
        },
        "sourceHome":{
            "type":"string",
            "description":"Source Oracle home path."
        },
        "ignoreprereq":{
            "type":"boolean",
            "default":false,
            "description":"To ignore the CVU pre-requisite checks."
        },
        "path":{
            "type":"string",
            "description":"The absolute path for the destination working copy."
        },
        "root":{
            "type":"boolean",
            "default":false,
            "description":"Use root credentials to access the remote node."
        },
        "sudoUser":{
            "type":"string",
            "description":"perform super user operations as sudo user name."
        },
        "sudoPath":{
            "type":"string",
            "description":"location of sudo binary."
        },
        "superUserPasswd":{
            "type":"string",
            "description":"The password for the super user account."
        },
        "authArgs":{
            "type":"object",
            "description":"Additional properties for the selected authentication plugin.",
            "additionalProperties":{
                "type":"string"
            }
        },
        "auth":{
            "type":"string",
            "description":"Use an authentication plugin to access the remote node."
        },
        "eval":{
            "type":"boolean",
            "default":false,
            "description":"Evaluate without executing the command."
        },
        "schedule":{
            "type":"string",
            "description":"Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05."
        },
        "batches":{
            "type":"string",
            "description":"Comma-delimited list of batches of nodes (where each batch is a comma-delimited list of node names enclosed in parentheses) enclosed in double quotation marks (\"\") in the format: \"(nA,nB,...),(...,nY,nZ)\"."
        },
        "abort":{
            "type":"boolean",
            "default":false,
            "description":"Abort the ongoing operation."
        },
        "revert":{
            "type":"boolean",
            "default":false,
            "description":"Downgrade after a failed upgrade of Oracle Grid Infrastructure."
        },
        "continue":{
            "type":"boolean",
            "default":false,
            "description":"Continue upgrading the next batch of nodes."
        },
        "gimrwc":{
            "type":"string",
            "description":"Name of the destination working copy to which the Grid Infrastructure Management Repository database needs to be upgraded."
        }
    }
}

ネストされたスキーマ: authArgs

タイプ: object

使用可能なその他のプロパティ

ソースの表示

string

{
    "type":"object",
    "description":"Additional properties for the selected authentication plugin.",
    "additionalProperties":{
        "type":"string"
    }
}

選択した認証プラグインの追加プロパティ。

セキュリティ

basicAuthentication: basic

タイプ: Basic

先頭に戻る

レスポンス

サポートされるメディア・タイプ

application/json
text/html

202 レスポンス

承認済。進行状況のステータスおよび出力を取得するために承認された操作のジョブ・リソース詳細を含むJSONオブジェクト。

ヘッダー

Location: string

操作を実行するジョブへのURL

ルート・スキーマ: jobResource

タイプ: object

ソースの表示

jobId: string
links: array links
operation: string
output: object jobOutputResource
status: string

指定できる値: [ "SCHEDULED", "UNKNOWN", "EXECUTING", "PAUSED", "ABORTED", "TERMINATED", "FAILED", "SUCCEEDED" ]

{
    "type":"object",
    "properties":{
        "jobId":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "SCHEDULED",
                "UNKNOWN",
                "EXECUTING",
                "PAUSED",
                "ABORTED",
                "TERMINATED",
                "FAILED",
                "SUCCEEDED"
            ]
        },
        "operation":{
            "type":"string"
        },
        "output":{
            "$ref":"#/definitions/jobOutputResource"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResourceLinks"
            }
        }
    }
}

ネストされたスキーマ: links

タイプ: array

ソースの表示

配列: オブジェクト singleResourceLinks

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/singleResourceLinks"
    }
}

ネストされたスキーマ: jobOutputResource

タイプ: object

ソースの表示

hasMore: boolean

デフォルト値: false
limit: integer
links: array links
offset: integer
output: string

{
    "type":"object",
    "properties":{
        "output":{
            "type":"string"
        },
        "limit":{
            "type":"integer"
        },
        "offset":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/collectionResourceLinks"
            }
        }
    }
}

ネストされたスキーマ: singleResourceLinks

タイプ: object

ソースの表示

href: string

絶対形式で指定された参照ハイパーリンク要素。
rel: string

指定できる値: [ "self", "collection", "up", "describedBy" ]

説明されたリソースを持つリンクの関係のタイプを指定します。

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Specify the type of relationship the link has with the described resource.",
            "enum":[
                "self",
                "collection",
                "up",
                "describedBy"
            ]
        },
        "href":{
            "type":"string",
            "description":"The referenced hyperlink element provided in an absolute format."
        }
    }
}

ネストされたスキーマ: links

タイプ: array

ソースの表示

配列: オブジェクト collectionResourceLinks

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/collectionResourceLinks"
    }
}

ネストされたスキーマ: collectionResourceLinks

タイプ: object

ソースの表示

href: string

正しいURLパラメータを持つ絶対形式で指定された参照ハイパーリンク要素。
rel: string

指定できる値: [ "next", "prev", "first", "last" ]

説明されたリソースを持つリンクの関係のタイプを指定します。

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Specify the type of relationship the link has with the described resource.",
            "enum":[
                "next",
                "prev",
                "first",
                "last"
            ]
        },
        "href":{
            "type":"string",
            "description":"The referenced hyperlink element provided in an absolute format with the correct URL parameters."
        }
    }
}

400 レスポンス

不正なリクエスト。パラメータ値または名前の解析中に見つかった問題のエラー詳細を含むJSONオブジェクト。

ルート・スキーマ: errorResource

タイプ: object

ソースの表示

errorCode: string

tittleに表示されるエラー・メッセージに関連する、アプリケーション固有のエラー・コード。
errorDetails: array errorDetails

複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。
errorPath: string

エラーの発生場所を示すXPathまたはJSONパス。
instance: string

エラーに関する詳細を提供するリンクへのURI。
status: integer

HTTPステータス・コード。
title: string

要約エラー・メッセージ。
type: string

HTTPエラー・コード・ページへのリンク。

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorDetails":{
            "type":"array",
            "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
            "items":{
                "$ref":"#/definitions/errorResource"
            }
        },
        "errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code, related to the error message shown at tittle."
        }
    }
}

ネストされたスキーマ: errorDetails

タイプ: array

複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。

ソースの表示

配列: オブジェクト errorResource

{
    "type":"array",
    "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
    "items":{
        "$ref":"#/definitions/errorResource"
    }
}

デフォルト・レスポンス

予期しないエラー操作の実行中の問題のエラー詳細を含むJSONオブジェクト。

ルート・スキーマ: errorResource

タイプ: object

ソースの表示

errorCode: string

tittleに表示されるエラー・メッセージに関連する、アプリケーション固有のエラー・コード。
errorDetails: array errorDetails

複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。
errorPath: string

エラーの発生場所を示すXPathまたはJSONパス。
instance: string

エラーに関する詳細を提供するリンクへのURI。
status: integer

HTTPステータス・コード。
title: string

要約エラー・メッセージ。
type: string

HTTPエラー・コード・ページへのリンク。

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorDetails":{
            "type":"array",
            "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
            "items":{
                "$ref":"#/definitions/errorResource"
            }
        },
        "errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code, related to the error message shown at tittle."
        }
    }
}

ネストされたスキーマ: errorDetails

タイプ: array

複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。

ソースの表示

配列: オブジェクト errorResource

{
    "type":"array",
    "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
    "items":{
        "$ref":"#/definitions/errorResource"
    }
}

先頭に戻る

例

次の例は、cURLを使用してRESTリソースに対するPUTリクエストを発行することによって、ソース作業用コピーからアップグレード先作業用コピーにOracle Grid Infrastructureソフトウェア・ホームをアップグレードする方法を示しています。

curl -u restUser -X PUT -H "Content-Type: application/json" -d "@body.json" "https://RHP_node_name:8894/rhp-restapi/rhp/workingcopies/GI_WCopy122/gihome/GI_WCopy183"

HTTPステータス・コードとレスポンス・ヘッダー

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 202
Location: https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,PUT,POST,DELETE,PATCH,OPTIONS
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Content-Length, Authorization
Connection: keep-alive
Content-Type: application/json
Content-Length: 159
Date:  Tue, 19 Jun 2018 14:03:23 GMT

リクエスト本体(body.json)

{
    "ignoreprereq" : true
}

レスポンス本体

{
     "links": [{
         "uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
         "rel": "self"
      }],
     "jobId": "1",
     "output": {  }
}

先頭に戻る