移動先

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

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

post

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

指定されたターゲットがサブスクライブされているイメージ情報を取得します。

リクエスト

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

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

すべてに一致

ソースの表示

• object schema
  ターゲットの詳細

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

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

型: object

ターゲットの詳細

ソースの表示

• targetName: string
  ターゲットの名前

  例: sales_db1
• targetType: string
  ターゲットのタイプ

  例: oracle_database

{
    "description":"Target details",
    "type":"object",
    "properties":{
        "targetName":{
            "description":"Name of the target",
            "type":"string",
            "example":"sales_db1"
        },
        "targetType":{
            "description":"Type of the target",
            "type":"string",
            "example":"oracle_database"
        }
    }
}

例

例の選択 ペイロード

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK。ターゲット・サブスクリプションの詳細が取得されました。

本文()

ルート・スキーマ: DatabaseGoldImageTargetSubscription

型: object

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

ソースの表示

• imageId: string
  イメージのID

  例: 4B7738536B6E7888E053057FB10ACF8C
• imageName: string
  イメージの名前

  例: FM_DB19_14_image
• parentId: string
  親のID

  例: 01DB50F6963F0E39C72F8651DCC93A6A
• targetId: string
  ターゲットのID

  例: 4B620EC24DCE61FAE053057FB10AC7D0
• targetName: string
  ターゲットの名前

  例: sales_db1
• targetType: string
  ターゲット・タイプ
• timeSubscribed: string (date-time)
  サブスクリプション時間

  例: 2022-01-13 15:52:28.0

{
    "type":"object",
    "description":"Target subscription input",
    "properties":{
        "targetId":{
            "description":"ID of the target",
            "type":"string",
            "example":"4B620EC24DCE61FAE053057FB10AC7D0"
        },
        "targetName":{
            "type":"string",
            "description":"Name of the target",
            "example":"sales_db1"
        },
        "targetType":{
            "type":"string",
            "description":"Target type"
        },
        "imageId":{
            "description":"ID of the image",
            "type":"string",
            "example":"4B7738536B6E7888E053057FB10ACF8C"
        },
        "imageName":{
            "description":"Name of the image",
            "type":"string",
            "example":"FM_DB19_14_image"
        },
        "timeSubscribed":{
            "description":"Subscription time",
            "type":"string",
            "format":"date-time",
            "example":"2022-01-13 15:52:28.0"
        },
        "parentId":{
            "description":"ID of the parent",
            "type":"string",
            "example":"01DB50F6963F0E39C72F8651DCC93A6A"
        }
    }
}

例

例の選択 ペイロード

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

先頭に戻る