ジャンプ先

• リクエスト
• レスポンス
• 例

管理対象外のOracle Databaseソフトウェア・ホームのアップグレード

PUT

/rhp-restapi/rhp/databases/{dbUniqueName}

指定したOracle Databaseソフトウェア・ホーム上のデータベースのアップグレード

リクエスト

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

• application/json

パス・パラメータ

• dbUniqueName: string
  プロビジョニングされるデータベースの名前(DB_UNIQUE_NAME)

ヘッダー・パラメータ

• Authorization: string
  リクエストをしているユーザーのユーザー名とパスワードのBase64エンコーディング。詳細は、高速ホーム・プロビジョニングの認証を参照してください。

Body ()

ルート・スキーマ: UpgradeDatabaseBody

タイプ: object

ソースの表示

• auth(optional): string
  認証プラグインを使用してリモート・ノードにアクセスします。
• authArgs(optional): object authArgs
  使用可能なその他のプロパティ: additionalProperties

  選択した認証プラグインの追加プロパティ。
• client(optional): string
  クライアント・クラスタ名
• eval(optional): boolean
  デフォルト値: false

  コマンドを実行せずに評価します。
• ignoreprereq(optional): boolean
  デフォルト値: false

  CVUの前提条件チェックを無視する場合。
• image(optional): string
  イメージの名前
• path(optional): string
  インポートするソフトウェア・ホームの絶対パスの場所(データベース・イメージの場合、これはORACLE_HOMEになります)。
• root(optional): boolean
  デフォルト値: false

  ルート資格証明を使用してリモート・ノードにアクセスします。
• schedule(optional): string
  ISO-8601形式の操作を実行する優先時間。例: 2016-12-21T19:13:17+05.
• sourcehome(optional): string
  ソースOracleホーム・パス
• sourcewc(optional): string
  Oracle Grid Infrastructureホームをアップグレードする必要があるソースの作業用コピーの名前。
• sudoPath(optional): string
  sudoバイナリの場所。
• sudoUser(optional): string
  sudoユーザー名としてスーパーユーザー操作を実行します。
• superUserPasswd(optional): string
  スーパーユーザー・アカウントのパスワード。
• targetnode(optional): string
  操作を実行する必要があるノード

{
    "type":"object",
    "properties":{
        "sourcewc":{
            "type":"string",
            "description":"Name of the source working copy from which the Oracle Grid Infrastructure needs to be upgraded."
        },
        "image":{
            "type":"string",
            "description":"Name of the image."
        },
        "client":{
            "type":"string",
            "description":"Client cluster name"
        },
        "targetnode":{
            "type":"string",
            "description":"Node on which operation needs to be executed"
        },
        "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":"Absolute path location of the software home to be imported (For database images, this will be the ORACLE_HOME)."
        },
        "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."
        }
    }
}

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

タイプ: object

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

ソースの表示

• string

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

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

セキュリティ

• basicAuthentication: basic
  タイプ: Basic

レスポンス

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

• application/json

202 レスポンス

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

ヘッダー

• Location: string
  操作を実行するジョブへのURL

Body ()

ルート・スキーマ: jobResource

タイプ: object

ソースの表示

• jobId(optional): string
• links(optional): array links
• operation(optional): string
• output(optional): object jobOutputResource
• status(optional): string

{
    "type":"object",
    "properties":{
        "jobId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "operation":{
            "type":"string"
        },
        "output":{
            "$ref":"#/definitions/jobOutputResource"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResourceLinks"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• [0]: object singleResourceLinks

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

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

タイプ: object

ソースの表示

• hasMore(optional): boolean
  デフォルト値: false
• limit(optional): integer
• links(optional): array links
• offset(optional): integer
• output(optional): 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(optional): string
  絶対形式で指定された参照ハイパーリンク要素。
• rel(optional): 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

ソースの表示

• [0]: object collectionResourceLinks

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

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

タイプ: object

ソースの表示

• href(optional): string
  正しいURLパラメータを持つ絶対形式で指定された参照ハイパーリンク要素。
• rel(optional): 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オブジェクト。

Body ()

ルート・スキーマ: errorResource

タイプ: object

ソースの表示

• errorCode(optional): string
  tittleに表示されるエラー・メッセージに関連する、アプリケーション固有のエラー・コード。
• errorDetails(optional): array errorDetails
  複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。
• errorPath(optional): string
  エラーの発生場所を示すXPathまたはJSONパス。
• instance(optional): string
  エラーに関する詳細を提供するリンクへのURI。
• status(optional): integer
  HTTPステータス・コード。
• title(optional): string
  要約エラー・メッセージ。
• type(optional): 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

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

ソースの表示

• [0]: object 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オブジェクト。

Body ()

ルート・スキーマ: errorResource

タイプ: object

ソースの表示

• errorCode(optional): string
  tittleに表示されるエラー・メッセージに関連する、アプリケーション固有のエラー・コード。
• errorDetails(optional): array errorDetails
  複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。
• errorPath(optional): string
  エラーの発生場所を示すXPathまたはJSONパス。
• instance(optional): string
  エラーに関する詳細を提供するリンクへのURI。
• status(optional): integer
  HTTPステータス・コード。
• title(optional): string
  要約エラー・メッセージ。
• type(optional): 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

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

ソースの表示

• [0]: object 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 Databaseソフトウェア・ホームから宛先作業用コピーへデータベースをアップグレードする方法を示しています。

curl -u restUser -X PUT -H "Content-Type: application/json" -d "@body.json" "https://RHP_node_name:8894/rhp-restapi/rhp/databases/dbwc1"

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)

{
    "sourceHome" : "/oracle/database/src/home",
    "destwc" : "DB_Wcopy181"
}

レスポンス本体

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