ジャンプ先

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

Oracle Databaseソフトウェアの作成

POST

/rhp-restapi/rhp/workingcopies/{workingCopyId}/databases

管理対象作業用コピーで新しいOracle Databaseをプロビジョニングします。

リクエスト

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

• application/json

パス・パラメータ

• workingCopyId(必須): string
  作業用コピーの名前。

ヘッダー・パラメータ

• Authorization(必須): string
  リクエストをしているユーザーのユーザー名とパスワードのBase64エンコーディング。詳細は、「フリート・パッチ適用およびプロビジョニングの認証」を参照してください。

Body ()

ルート・スキーマ: AddDatabaseBody

タイプ: object

ソースの表示

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

  選択した認証プラグインの追加プロパティ。
• cardinality: string
  新しいサーバー・プールのカーディナリティ
• cdb: boolean
  デフォルト値: false

  データベースをコンテナ・データベースとして作成する場合
• datafileDestination: string
  データ・ファイル宛先場所またはASMディスク・グループ名
• dbcaAdditionalArgs: string
  空白で区切られたDBCA追加コマンドライン引数
• dbcaInitParams: string
  データベース初期化パラメータとその値のname=valueペアのカンマ区切りリスト
• dbTemplate: string
  テンプレート・ファイルの絶対ファイル・パス、または高速ホーム・プロビジョニング・サーバー上のイメージ・ホーム・ディレクトリへの相対パス
• dbType: string
  指定できる値: [ "RAC", "RACONENODE", "SINGLE" ]

  データベースのタイプ: Oracle RAC One Node、Oracle RACまたはSingle Instance
• eval: boolean
  デフォルト値: false

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

  Grid Infrastructure Management Repository (GIMR)データベースに必要な操作を実行する場合
• newpool: string
  作成するプールのサーバー・プール名
• newpqpool: string
  作成するプールのサーバー・プール名
• nodes: string
  データベースが作成されるノードのカンマ区切りリスト
• numberOfPDBs: integer(int32)
  作成するPDBの数
• pdbname: string
  1つ以上のPDBを作成する必要がある場合のpdbname接頭辞
• pqcardinality: string
  新しいPQプールのカーディナリティ
• pqpool: string
  既存のPQプール名
• root: boolean
  デフォルト値: false

  ルート資格証明を使用してリモート・ノードにアクセスします。
• schedule: string
  ISO-8601形式の操作を実行する優先時間。たとえば: 2016-12-21T19:13:17+05.
• serverpool: string
  既存のサーバー・プール名のカンマ区切りリスト
• sudoPath: string
  sudoバイナリの場所。
• sudoUser: string
  sudoユーザー名としてスーパーユーザー操作を実行します。
• superUserPasswd: string
  スーパーユーザー・アカウントのパスワード。
• targetNode: string
  操作を実行する必要があるノード
• userActionData: string
  useractionスクリプトのuseractiondataパラメータに渡される値

{
    "type":"object",
    "properties":{
        "pqpool":{
            "type":"string",
            "description":"Existing PQ pool name"
        },
        "newpqpool":{
            "type":"string",
            "description":"Server pool name for pool to be created"
        },
        "pqcardinality":{
            "type":"string",
            "description":"Cardinality for new PQ pool"
        },
        "dbTemplate":{
            "type":"string",
            "description":"Absolute file path for the template file or relative path to the image home directory on Rapid Home Provisioning Server"
        },
        "targetNode":{
            "type":"string",
            "description":"Node on which operation needs to be executed"
        },
        "datafileDestination":{
            "type":"string",
            "description":"Data file destination location or ASM disk group name"
        },
        "numberOfPDBs":{
            "type":"integer",
            "format":"int32",
            "description":"Number of PDBs to be created"
        },
        "pdbname":{
            "type":"string",
            "description":"The pdbname prefix if one or more PDBs need to be created"
        },
        "cdb":{
            "type":"boolean",
            "default":false,
            "description":"To create database as container database"
        },
        "dbType":{
            "type":"string",
            "enum":[
                "RAC",
                "RACONENODE",
                "SINGLE"
            ],
            "description":"Type of database: Oracle RAC One Node or Oracle RAC or Single Instance"
        },
        "userActionData":{
            "type":"string",
            "description":"Value to be passed to useractiondata parameter of useraction script"
        },
        "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."
        },
        "gimr":{
            "type":"boolean",
            "default":false,
            "description":"To perform the operations required for a Grid Infrastructure Management Repository (GIMR) database"
        },
        "cardinality":{
            "type":"string",
            "description":"Cardinality for new server pool"
        },
        "dbcaAdditionalArgs":{
            "type":"string",
            "description":"DBCA additional command line arguments separated by space"
        },
        "dbcaInitParams":{
            "type":"string",
            "description":"Comma-separated list of name=value pairs of the database initialization parameters and their valuescomma-separated list of name=value pairs of the database initialization parameters and their values"
        },
        "newpool":{
            "type":"string",
            "description":"Server pool name for pool to be created"
        },
        "nodes":{
            "type":"string",
            "description":"Comma-separated list of nodes on which database will be created"
        },
        "serverpool":{
            "type":"string",
            "description":"Comma-separated list of existing server pool names"
        }
    }
}

ネストされたスキーマ: 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

Body ()

ルート・スキーマ: 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オブジェクト。

Body ()

ルート・スキーマ: 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オブジェクト。

Body ()

ルート・スキーマ: 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リソースに対するPOSTリクエストを発行することによって、リクエスト本体body.jsonですべての引数が指定されている管理対象作業用コピーで新しいOracle Dtabaseインスタンスをプロビジョニングする方法を示しています。

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

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)

{
    "dbname" : "dbwc1"
}

レスポンス本体

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

先頭に戻る