Oracle Enterprise ManagerのREST API

イメージへのターゲットのサブスクライブ

post

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}/actions/subscribeTargets

イメージにターゲットをサブスクライブします。ターゲットは、同じリリースに(パッチ適用の目的で)することも、ダイレクト・アップグレード・パスを使用できる下位リリースにすることもできます。

リクエスト

パス・パラメータ

goldImageId(必須): string

イメージのID

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

application/json

ルート・スキーマ: schema

型: object

すべてに一致

ソースの表示

object allOf SubscribeTargetsDetails

ターゲットのサブスクリプションの詳細

{
    "type":"object",
    "required":[
        "targetList",
        "targetType"
    ],
    "allOf":[
        {
            "$ref":"#/components/schemas/SubscribeTargetsDetails"
        }
    ]
}

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

型: object

ターゲットのサブスクリプションの詳細

すべてに一致

ソースの表示

object TargetList

ターゲットのリスト
object SubscribeTargetCommonDetails

イメージへのターゲットのサブスクリプションに関する共通詳細

{
    "description":"Details of subscription of targets",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TargetList"
        },
        {
            "$ref":"#/components/schemas/SubscribeTargetCommonDetails"
        }
    ]
}

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

型: object

ターゲットのリスト

ソースの表示

targetList: array targetList

ターゲット名の配列。
targetType: string

ターゲット・タイプ

例: oracle_database

{
    "description":"List of targets",
    "type":"object",
    "properties":{
        "targetList":{
            "description":"Array of target names",
            "type":"array",
            "items":{
                "type":"string",
                "example":"db1, db2"
            }
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

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

型: object

イメージへのターゲットのサブスクリプションに関する共通詳細

ソースの表示

isGimr: boolean

GIMRフラグ
isNoCascade: boolean

デフォルト値: false

CDB内のPDBのサブスクリプションを示すフラグ
isStandbyAutoSubscribe: boolean

デフォルト値: true

スタンバイ・データベースの自動サブスクリプションを示すフラグ

{
    "description":"Common details for subscription of a target to the image",
    "type":"object",
    "properties":{
        "isStandbyAutoSubscribe":{
            "description":"Flag to indicate the auto subscription of a standby database",
            "type":"boolean",
            "default":true
        },
        "isNoCascade":{
            "description":"Flag to indicate the subscription of PDBs in a CDB",
            "type":"boolean",
            "default":false
        },
        "isGimr":{
            "description":"GIMR Flag",
            "type":"boolean"
        }
    }
}

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

型: array

ターゲット名の配列。

ソースの表示

配列: string

例: db1, db2

{
    "description":"Array of target names",
    "type":"array",
    "items":{
        "type":"string",
        "example":"db1, db2"
    }
}

例

先頭に戻る

レスポンス

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

application/json

200レスポンス

OK。サブスクライブされたターゲット。

ルート・スキーマ: schema

型: object

すべてに一致

ソースの表示

object allOf GoldImageSubscribeTargets

ターゲット・サブスクリプションのレスポンス

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

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

型: object

ターゲット・サブスクリプションのレスポンス

すべてに一致

ソースの表示

object GoldImageTargetsSubscriptionSummary

ターゲット・サブスクリプションの詳細

{
    "description":"Targets subscription response",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageTargetsSubscriptionSummary"
        }
    ]
}

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

型: object

ターゲット・サブスクリプションの詳細

ソースの表示

failed: integer

失敗したターゲットの数
items: array items

サブスクリプションのサマリーのリスト
successful: integer

成功したターゲットの数
total: integer

合計ターゲット数

{
    "description":"Targets subscription details",
    "type":"object",
    "properties":{
        "failed":{
            "description":"Count of Failed targets",
            "type":"integer"
        },
        "successful":{
            "description":"Count of Successful targets",
            "type":"integer"
        },
        "total":{
            "description":"Count of Total targets",
            "type":"integer"
        },
        "items":{
            "description":"List of subscription summary",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubscriptionSummary"
            }
        }
    }
}

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

型: array

サブスクリプションのサマリーのリスト

ソースの表示

配列: object SubscriptionSummary

ターゲット・サブスクリプションのサマリー

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

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

型: object

ターゲット・サブスクリプションのサマリー

ソースの表示

code: integer

HTTPステータス・コード
message: string

サブスクリプションのメッセージ
targetId: string

ターゲットのID

例: 01DB50F6963F0E39C72F8651DCC93A6A
targetName: string

ターゲットの名前

例: sales_db1
targetType: string

ターゲット・タイプ

例: oracle_database

{
    "description":"Target subscription summary",
    "type":"object",
    "properties":{
        "code":{
            "description":"HTTP status code",
            "type":"integer"
        },
        "targetId":{
            "description":"ID of the target",
            "type":"string",
            "example":"01DB50F6963F0E39C72F8651DCC93A6A"
        },
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Target type",
            "type":"string",
            "example":"oracle_database"
        },
        "message":{
            "description":"Message of subscription",
            "type":"string"
        }
    }
}

例

400レスポンス

不正なリクエスト。ペイロードがnullであるか、一部のパラメータがありません

ルート・スキーマ: 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"
        }
    }
}

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"
        }
    }
}

404レスポンス

見つかりません。リクエストされたREST API URLが見つかりません。

ルート・スキーマ: 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"
        }
    }
}

先頭に戻る