ジャンプ先

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

イメージの登録操作のスケジュール

POST

/rhp-restapi/rhp/images/repository

指定したパスから新しいイメージを登録します

リクエスト

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

• application/json

ヘッダー・パラメータ

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

Body ()

ルート・スキーマ: RegisterImageBody

タイプ: object

ソースの表示

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

  選択した認証プラグインの追加プロパティ。
• client: string
  クライアント・クラスタ名
• cred: string
  リモート・ノードへのアクセスのためのユーザー/パスワード資格証明に関連付ける資格証明名
• imageName: string
  イメージの名前
• imageType: string
  ソフトウェア・タイプ。(Oracle Databaseソフトウェアの場合は"ORACLEDBSOFTWARE" (デフォルト)、Oracle Exadataソフトウェアの場合は"EXAPATCHSOFTWARE"、Oracle Grid Infrastructureソフトウェアの場合は"ORACLEGISOFTWARE"、Oracle GoldenGateソフトウェアの場合は"ORACLEGGSOFTWARE"、linux Opearting System ISOの場合は"LINUXOS"、その他のすべてのソフトウェアの場合は"SOFTWARE"です。カスタム・イメージ・タイプの場合はイメージ・タイプ名を使用します。)
• location: string
  ターゲット上の圧縮されたイメージ・ファイルの場所
• ossurl: string
  OSSマッピング・ファイルが置かれているURL
• path: string
  インポートするソフトウェア・ホームの絶対パスの場所(データベース・イメージの場合、これはORACLE_HOMEになります)
• pathOwner: string
  指定したパスの下のファイルへの読取りアクセス権を持つユーザー
• root: boolean
  デフォルト値: false

  ルート資格証明を使用してリモート・ノードにアクセスします
• schedule: string
  ISO-8601形式の操作を実行する優先時間。たとえば: 2016-12-21T19:13:17+05
• state: string
  指定できる値: [ "TESTABLE", "RESTRICTED", "PUBLISHED" ]

  状態名
• sudoPath: string
  sudoバイナリの場所
• sudoUser: string
  sudoユーザー名としてスーパーユーザー操作を実行します
• targetNode: string
  操作を実行する必要があるノード
• temploc: string
  登録するイメージをダウンロードするための一時的な場所として使用する絶対パスを取得します。
• userActionData: string
  useractionスクリプトのuseractiondataパラメータに渡される値
• version: string
  GIAASの場合はOracle Databaseのバージョン、ODAPATCHSOFTWAREの場合はODAパッチバンドルのバージョン、EXAPATCHSOFTWAREの場合はExadataイメージのバージョン
• zip: string
  インポートする圧縮ソフトウェア・ホームの絶対パス(ZIPまたはTARファイル)

{
    "type":"object",
    "properties":{
        "imageName":{
            "type":"string",
            "description":"Name of the image"
        },
        "path":{
            "type":"string",
            "description":"Absolute path location of the software home to be imported (For database images, this will be the ORACLE_HOME)"
        },
        "zip":{
            "type":"string",
            "description":"Absolute path of the compressed software home to be imported (a ZIP or TAR file)"
        },
        "imageType":{
            "type":"string",
            "description":"The software type. (\"ORACLEDBSOFTWARE\" (default) for Oracle database software, \"EXAPATCHSOFTWARE\" for Oracle Exadata software, \"ORACLEGISOFTWARE\" for Oracle Grid Infrastructure software, \"ORACLEGGSOFTWARE\" for Oracle GoldenGate software, \"LINUXOS\" for linux Opearting System ISO, and \"SOFTWARE\" for all other software. For a custom image type, use the image type name.)"
        },
        "pathOwner":{
            "type":"string",
            "description":"User with read access to files under the specified path"
        },
        "state":{
            "type":"string",
            "description":"State name",
            "enum":[
                "TESTABLE",
                "RESTRICTED",
                "PUBLISHED"
            ]
        },
        "client":{
            "type":"string",
            "description":"Client cluster name"
        },
        "targetNode":{
            "type":"string",
            "description":"Node on which operation needs to be executed"
        },
        "sudoPath":{
            "type":"string",
            "description":"location of sudo binary"
        },
        "sudoUser":{
            "type":"string",
            "description":"perform super user operations as sudo user name"
        },
        "root":{
            "type":"boolean",
            "default":false,
            "description":"Use root credentials to access the remote node"
        },
        "schedule":{
            "type":"string",
            "description":"Preferred time to execute the operation, in ISO-8601 format. For example: 2016-12-21T19:13:17+05"
        },
        "userActionData":{
            "type":"string",
            "description":"Value to be passed to useractiondata parameter of useraction script"
        },
        "cred":{
            "type":"string",
            "description":"Credential name to associate the user/password credentials to access a remote node"
        },
        "ossurl":{
            "type":"string",
            "description":"URL where the OSS mapping file is located"
        },
        "version":{
            "type":"string",
            "description":"Oracle database version for GIAAS, ODA patchbundle version for ODAPATCHSOFTWARE, Exadata image version for EXAPATCHSOFTWARE"
        },
        "location":{
            "type":"string",
            "description":"Location of the compressed image file on the target"
        },
        "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."
        },
        "temploc":{
            "type":"string",
            "description":"Get the absolute path to be used as temporary location to download the image that will be registered."
        }
    }
}

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

先頭に戻る