移動先

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

イメージ・バージョンの取得

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}/versions/{versionId}

指定されたバージョンのイメージに関する情報を取得します

リクエスト

パス・パラメータ

• goldImageId(必須): string
  イメージのID
• versionId(必須): string
  イメージ・バージョンのID

問合せパラメータ

• include: string
  このバージョンのイメージを削除できる場合はレポートを提示します

  指定可能な値: [ "deleteVersionReport" ]

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK。イメージ・バージョンが取得されました。

本文()

ルート・スキーマ: GoldImageVersion

型: object

イメージ・バージョンのサマリー

すべてに一致

ソースの表示

• object GoldImageVersionSummary
  イメージ・バージョンのサマリー

{
    "description":"Summary of the image version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageVersionSummary"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/DeleteGoldImageVersionReport"
        }
    ]
}

1つのスキーマに一致

ソースの表示

• object DeleteGoldImageVersionReport
  ゴールド・イメージ・バージョンの削除レポート

{
    "description":"Summary of the image version",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageVersionSummary"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/DeleteGoldImageVersionReport"
        }
    ]
}

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

型: object

イメージ・バージョンのサマリー

ソースの表示

• externalId: string
  イメージ・バージョンの外部ID

  例: oracle:defaultService:em:provisioning:1:cmp:COMP_Component:SUB_OracleDB:4BAFA861A7E96603E053057FB10A0588:0.1
• hashCode: string
  イメージ・バージョンのHashCode

  例: C1622270664:B<NO_PATCHES>
• id: string
  イメージ・バージョンのID

  例: 4BAFA861A7ED6603E053057FB10A0588
• imageId: string
  イメージのID

  例: 4B7738536B6E7888E053057FB10ACF8C
• links: object links
  ナビゲーション・リンク
• name: string
  イメージ・バージョンの名前

  例: PSUNos
• position: string
  イメージ・バージョンの位置

  例: 1
• provisioningStatus: string
  プロビジョニングのステータス

  例: READY
• releaseVersion: string
  バージョンのRU詳細

  例: 19.12.0.0.0
• status: string
  イメージ・バージョンのステータス

  例: CURRENT
• timeCreated: string (date-time)
  イメージ・バージョンの作成時間

  例: 2017-03-27 10:13:28.0

{
    "description":"Summary of the image version",
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of the image version",
            "type":"string",
            "example":"PSUNos"
        },
        "id":{
            "description":"ID of the image version",
            "type":"string",
            "example":"4BAFA861A7ED6603E053057FB10A0588"
        },
        "imageId":{
            "description":"ID of the image",
            "type":"string",
            "example":"4B7738536B6E7888E053057FB10ACF8C"
        },
        "externalId":{
            "description":"External ID of the image version",
            "type":"string",
            "example":"oracle:defaultService:em:provisioning:1:cmp:COMP_Component:SUB_OracleDB:4BAFA861A7E96603E053057FB10A0588:0.1"
        },
        "status":{
            "description":"Status of the image version",
            "type":"string",
            "example":"CURRENT"
        },
        "position":{
            "description":"Position of a image version",
            "type":"string",
            "example":"1"
        },
        "hashCode":{
            "description":"HashCode of the image version",
            "type":"string",
            "example":"C1622270664:B<NO_PATCHES>"
        },
        "timeCreated":{
            "description":"Creation time of the image version",
            "type":"string",
            "format":"date-time",
            "example":"2017-03-27 10:13:28.0"
        },
        "provisioningStatus":{
            "description":"Status of the provisioning",
            "type":"string",
            "example":"READY"
        },
        "releaseVersion":{
            "description":"RU details of the version",
            "type":"string",
            "example":"19.12.0.0.0"
        },
        "links":{
            "type":"object",
            "description":"Navigation links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                }
            }
        }
    }
}

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

型: object

ゴールド・イメージ・バージョンの削除レポート

ソースの表示

• message: string
  イメージ・バージョンを削除できるかどうかを示すメッセージ

  例: if the version is not CURRENT then message is "The version is a candidate for deletion." else message is "CURRENT version of the image cannot be deleted"

{
    "description":"Delete gold image version report",
    "type":"object",
    "properties":{
        "message":{
            "description":"Message indicates whether image version can be deleted",
            "type":"string",
            "example":"if the version is not CURRENT then message is \"The version is a candidate for deletion.\" else message is \"CURRENT version of the image cannot be deleted\""
        }
    }
}

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

型: object

ナビゲーション・リンク

ソースの表示

• self: object Link
  リンクを表します(self、previous、nextのいずれか)

{
    "type":"object",
    "description":"Navigation links",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        }
    }
}

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

型: object

リンクを表します(self、previous、nextのいずれか)

ソースの表示

• href: string
  リンクのためのURL

  例: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

例

例の選択 ペイロード

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

先頭に戻る