Oracle Enterprise ManagerのREST API

FPPイメージ・シリーズのオプトイン

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/actions/fppSeriesOptIn

Enterprise Managerからのデータベース・メンテナンス・アクティビティに使用されるFPPイメージ・シリーズをオプトインします。ノート - FPPイメージ・シリーズはイメージとして示されます。このイメージ・シリーズの様々なイメージがEnterprise Managerではバージョンとして表示されます。

リクエスト

この操作にはリクエスト・パラメータはありません。

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

application/json

ルート・スキーマ: schema

型: object

1つのスキーマに一致

ソースの表示

object FppSeriesOptInDetails

FPPシリーズのオプトインの詳細
object ExapatchOptInDetails

Exapatchシリーズのオプトイン詳細

{
    "type":"object",
    "oneOf":[
        {
            "$ref":"#/components/schemas/FppSeriesOptInDetails"
        },
        {
            "$ref":"#/components/schemas/ExapatchOptInDetails"
        }
    ]
}

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

型: object

FPPシリーズのオプトインの詳細

すべてに一致

ソースの表示

object FppSeriesOptInInputDetails

FPPイメージ・シリーズの詳細

{
    "description":"Opt-In details for FPP series",
    "type":"object",
    "required":[
        "series"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/FppSeriesOptInInputDetails"
        }
    ]
}

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

型: object

Exapatchシリーズのオプトイン詳細

すべてに一致

ソースの表示

object ExapatchOptInInputDetails

Exapatchイメージ・シリーズの詳細

{
    "description":"Opt-In Details for Exapatch Series",
    "type":"object",
    "required":[
        "series"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/ExapatchOptInInputDetails"
        }
    ]
}

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

型: object

FPPイメージ・シリーズの詳細

ソースの表示

series: array series

イメージ・シリーズの配列

{
    "type":"object",
    "description":"FPP image series details",
    "properties":{
        "series":{
            "description":"Array of the image series",
            "type":"array",
            "items":{
                "type":"object",
                "oneOf":[
                    {
                        "required":[
                            "seriesName",
                            "serverName"
                        ]
                    },
                    {
                        "required":[
                            "seriesId"
                        ]
                    }
                ],
                "properties":{
                    "seriesId":{
                        "type":"string",
                        "description":"ID of the FPP series"
                    },
                    "seriesName":{
                        "type":"string",
                        "description":"Name of the FPP series"
                    },
                    "serverName":{
                        "type":"string",
                        "description":"FPP server cluster name"
                    },
                    "currentVersionImageId":{
                        "type":"string",
                        "description":"ID of the image version to be marked as current"
                    }
                }
            }
        }
    }
}

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

型: array

イメージ・シリーズの配列

ソースの表示

配列: object items

{
    "description":"Array of the image series",
    "type":"array",
    "items":{
        "type":"object",
        "oneOf":[
            {
                "required":[
                    "seriesName",
                    "serverName"
                ]
            },
            {
                "required":[
                    "seriesId"
                ]
            }
        ],
        "properties":{
            "seriesId":{
                "type":"string",
                "description":"ID of the FPP series"
            },
            "seriesName":{
                "type":"string",
                "description":"Name of the FPP series"
            },
            "serverName":{
                "type":"string",
                "description":"FPP server cluster name"
            },
            "currentVersionImageId":{
                "type":"string",
                "description":"ID of the image version to be marked as current"
            }
        }
    }
}

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

型: object

ソースの表示

currentVersionImageId: string

現在としてマークするイメージ・バージョンのID
seriesId: string

FPPシリーズのID
seriesName: string

FPPシリーズの名前
serverName: string

FPPサーバー・クラスタ名

{
    "type":"object",
    "oneOf":[
        {
            "required":[
                "seriesName",
                "serverName"
            ]
        },
        {
            "required":[
                "seriesId"
            ]
        }
    ],
    "properties":{
        "seriesId":{
            "type":"string",
            "description":"ID of the FPP series"
        },
        "seriesName":{
            "type":"string",
            "description":"Name of the FPP series"
        },
        "serverName":{
            "type":"string",
            "description":"FPP server cluster name"
        },
        "currentVersionImageId":{
            "type":"string",
            "description":"ID of the image version to be marked as current"
        }
    }
}

1つのスキーマに一致

ソースの表示

{
    "type":"object",
    "oneOf":[
        {
            "required":[
                "seriesName",
                "serverName"
            ]
        },
        {
            "required":[
                "seriesId"
            ]
        }
    ],
    "properties":{
        "seriesId":{
            "type":"string",
            "description":"ID of the FPP series"
        },
        "seriesName":{
            "type":"string",
            "description":"Name of the FPP series"
        },
        "serverName":{
            "type":"string",
            "description":"FPP server cluster name"
        },
        "currentVersionImageId":{
            "type":"string",
            "description":"ID of the image version to be marked as current"
        }
    }
}

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

型: object

Exapatchイメージ・シリーズの詳細

ソースの表示

series: array series

イメージ・シリーズの配列

{
    "type":"object",
    "description":"Exapatch Image Series details",
    "properties":{
        "series":{
            "description":"Array of Image Series",
            "type":"array",
            "items":{
                "type":"object",
                "oneOf":[
                    {
                        "required":[
                            "seriesName",
                            "serverName",
                            "currentVersionImageId",
                            "targetType",
                            "imageFile"
                        ]
                    },
                    {
                        "required":[
                            "seriesId",
                            "currentVersionImageId",
                            "targetType",
                            "imageFile"
                        ]
                    }
                ],
                "properties":{
                    "seriesId":{
                        "type":"string",
                        "description":"seriesid",
                        "example":"E6C5858BD2B46B37E05380FE4564A69B"
                    },
                    "seriesName":{
                        "type":"string",
                        "description":"series name",
                        "example":"Exadata_DB_Series_1_12"
                    },
                    "serverName":{
                        "type":"string",
                        "description":"FPP Server Cluster name",
                        "example":"myFPPserver"
                    },
                    "currentVersionImageId":{
                        "type":"string",
                        "description":"VersionId to be marked as current",
                        "example":"E5B98897FE871AC1E05380FE4564F682"
                    },
                    "targetType":{
                        "type":"string",
                        "description":"targetType for given version",
                        "example":"host"
                    },
                    "imageFile":{
                        "type":"string",
                        "description":"Zip file name that contains the patch image.",
                        "example":"p34752810_191200_Linux-x86-64.zip"
                    },
                    "patchManagerLocation":{
                        "type":"string",
                        "description":"location needed for host target type",
                        "example":"p34752811_191200_Linux-x86-64.zip"
                    }
                }
            }
        }
    }
}

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

型: array

イメージ・シリーズの配列

ソースの表示

配列: object items

{
    "description":"Array of Image Series",
    "type":"array",
    "items":{
        "type":"object",
        "oneOf":[
            {
                "required":[
                    "seriesName",
                    "serverName",
                    "currentVersionImageId",
                    "targetType",
                    "imageFile"
                ]
            },
            {
                "required":[
                    "seriesId",
                    "currentVersionImageId",
                    "targetType",
                    "imageFile"
                ]
            }
        ],
        "properties":{
            "seriesId":{
                "type":"string",
                "description":"seriesid",
                "example":"E6C5858BD2B46B37E05380FE4564A69B"
            },
            "seriesName":{
                "type":"string",
                "description":"series name",
                "example":"Exadata_DB_Series_1_12"
            },
            "serverName":{
                "type":"string",
                "description":"FPP Server Cluster name",
                "example":"myFPPserver"
            },
            "currentVersionImageId":{
                "type":"string",
                "description":"VersionId to be marked as current",
                "example":"E5B98897FE871AC1E05380FE4564F682"
            },
            "targetType":{
                "type":"string",
                "description":"targetType for given version",
                "example":"host"
            },
            "imageFile":{
                "type":"string",
                "description":"Zip file name that contains the patch image.",
                "example":"p34752810_191200_Linux-x86-64.zip"
            },
            "patchManagerLocation":{
                "type":"string",
                "description":"location needed for host target type",
                "example":"p34752811_191200_Linux-x86-64.zip"
            }
        }
    }
}

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

型: object

ソースの表示

currentVersionImageId: string

現行としてマークされるVersionId

例: E5B98897FE871AC1E05380FE4564F682
imageFile: string

パッチ・イメージを含むZipファイル名。

例: p34752810_191200_Linux-x86-64.zip
patchManagerLocation: string

ホスト・ターゲット・タイプに必要な場所

例: p34752811_191200_Linux-x86-64.zip
seriesId: string

seriesid

例: E6C5858BD2B46B37E05380FE4564A69B
seriesName: string

シリーズ名

例: Exadata_DB_Series_1_12
serverName: string

FPPサーバー・クラスタ名

例: myFPPserver
targetType: string

指定されたバージョンのtargetType

例: host

{
    "type":"object",
    "oneOf":[
        {
            "required":[
                "seriesName",
                "serverName",
                "currentVersionImageId",
                "targetType",
                "imageFile"
            ]
        },
        {
            "required":[
                "seriesId",
                "currentVersionImageId",
                "targetType",
                "imageFile"
            ]
        }
    ],
    "properties":{
        "seriesId":{
            "type":"string",
            "description":"seriesid",
            "example":"E6C5858BD2B46B37E05380FE4564A69B"
        },
        "seriesName":{
            "type":"string",
            "description":"series name",
            "example":"Exadata_DB_Series_1_12"
        },
        "serverName":{
            "type":"string",
            "description":"FPP Server Cluster name",
            "example":"myFPPserver"
        },
        "currentVersionImageId":{
            "type":"string",
            "description":"VersionId to be marked as current",
            "example":"E5B98897FE871AC1E05380FE4564F682"
        },
        "targetType":{
            "type":"string",
            "description":"targetType for given version",
            "example":"host"
        },
        "imageFile":{
            "type":"string",
            "description":"Zip file name that contains the patch image.",
            "example":"p34752810_191200_Linux-x86-64.zip"
        },
        "patchManagerLocation":{
            "type":"string",
            "description":"location needed for host target type",
            "example":"p34752811_191200_Linux-x86-64.zip"
        }
    }
}

1つのスキーマに一致

ソースの表示

{
    "type":"object",
    "oneOf":[
        {
            "required":[
                "seriesName",
                "serverName",
                "currentVersionImageId",
                "targetType",
                "imageFile"
            ]
        },
        {
            "required":[
                "seriesId",
                "currentVersionImageId",
                "targetType",
                "imageFile"
            ]
        }
    ],
    "properties":{
        "seriesId":{
            "type":"string",
            "description":"seriesid",
            "example":"E6C5858BD2B46B37E05380FE4564A69B"
        },
        "seriesName":{
            "type":"string",
            "description":"series name",
            "example":"Exadata_DB_Series_1_12"
        },
        "serverName":{
            "type":"string",
            "description":"FPP Server Cluster name",
            "example":"myFPPserver"
        },
        "currentVersionImageId":{
            "type":"string",
            "description":"VersionId to be marked as current",
            "example":"E5B98897FE871AC1E05380FE4564F682"
        },
        "targetType":{
            "type":"string",
            "description":"targetType for given version",
            "example":"host"
        },
        "imageFile":{
            "type":"string",
            "description":"Zip file name that contains the patch image.",
            "example":"p34752810_191200_Linux-x86-64.zip"
        },
        "patchManagerLocation":{
            "type":"string",
            "description":"location needed for host target type",
            "example":"p34752811_191200_Linux-x86-64.zip"
        }
    }
}

例

先頭に戻る

レスポンス

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

application/json

200レスポンス

OK。FPPイメージ・シリーズのオプトインが完了しました。

ルート・スキーマ: schema

型: object

すべてに一致

ソースの表示

object allOf GoldImageFppSeriesOptIn

FPPイメージ・シリーズのオプトインのレスポンス

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageFppSeriesOptIn"
        }
    ]
}

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

型: object

FPPイメージ・シリーズのオプトインのレスポンス

すべてに一致

ソースの表示

object FppSeriesOptInOptOutResult

FPPイメージ・シリーズのオプトイン/アウトの結果

{
    "description":"FPP image series Opt-In response",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/FppSeriesOptInOptOutResult"
        }
    ]
}

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

型: object

FPPイメージ・シリーズのオプトイン/アウトの結果

ソースの表示

failed: integer

失敗したシリーズの数
items: array items

アイテムのリスト
successful: integer

成功したシリーズの数
total: integer

合計シリーズ数

{
    "description":"FPP image series Opt-In/Out result",
    "type":"object",
    "properties":{
        "failed":{
            "description":"Count of failed series",
            "type":"integer"
        },
        "successful":{
            "description":"Count of successful series",
            "type":"integer"
        },
        "total":{
            "description":"Count of total series",
            "type":"integer"
        },
        "items":{
            "description":"List of items",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FppSeriesOptInResultSummary"
            }
        }
    }
}

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

型: array

アイテムのリスト

ソースの表示

配列: object FppSeriesOptInResultSummary

FPPイメージ・シリーズのオプトインのレスポンス

{
    "description":"List of items",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FppSeriesOptInResultSummary"
    }
}

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

型: object

FPPイメージ・シリーズのオプトインのレスポンス

ソースの表示

code: integer

シリーズのオプトインのHTTPステータス・コード
message: string

オプトイン・メッセージ
seriesId: string

FPPシリーズのID
seriesName: string

FPPシリーズの名前
serverName: string

FPPサーバー・クラスタ名

{
    "description":"FPP image series Opt-In response",
    "type":"object",
    "properties":{
        "code":{
            "description":"Series Opt-In HTTP status code",
            "type":"integer"
        },
        "seriesId":{
            "description":"ID of the FPP series",
            "type":"string"
        },
        "seriesName":{
            "description":"Name of the FPP series",
            "type":"string"
        },
        "serverName":{
            "description":"FPP server cluster name",
            "type":"string"
        },
        "message":{
            "description":"Opt-In message",
            "type":"string"
        }
    }
}

例

401レスポンス

未認可。ユーザーにはリクエストされた操作を実行する権限がありません

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

403レスポンス

禁止。ユーザーは、リクエストされた操作の実行を禁止されています

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500レスポンス

内部サーバー・エラー。REST APIの実行中に例外が発生しました。

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503レスポンス

サービスが使用できません。サーバーはリクエストを処理できません。

ルート・スキーマ: ErrorResponse

型: object

エラー・レスポンス

ソースの表示

code(必須): string

プログラムによる解析を目的とした、エラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

先頭に戻る