移動先

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

イメージの取得

get

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

イメージ情報を取得します

リクエスト

パス・パラメータ

• goldImageId(必須): string
  イメージのID

問合せパラメータ

• include: string
  削除可能なこのイメージのバージョン、または同じサブスクライバがない場合にはイメージも削除されるかどうかに関するレポートを提示します

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

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK。イメージ情報が取得されました。

本文()

ルート・スキーマ: GoldImage

イメージのサマリー

すべてに一致

ソースの表示

• object GoldImageCommonSummary
  共通イメージ・サマリー

{
    "description":"Summary of the image",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageCommonSummary"
        }
    ],
    "x-anyOf":[
        {
            "$ref":"#/components/schemas/DeleteGoldImageReport"
        }
    ]
}

いずれかに一致

ソースの表示

• object DeleteGoldImageReport
  ゴールド・イメージの削除レポート

{
    "description":"Summary of the image",
    "allOf":[
        {
            "$ref":"#/components/schemas/GoldImageCommonSummary"
        }
    ],
    "x-anyOf":[
        {
            "$ref":"#/components/schemas/DeleteGoldImageReport"
        }
    ]
}

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

型: object

共通イメージ・サマリー

ソースの表示

• createdBy: string
  イメージの所有者

  例: ADMIN
• description: string
  イメージの説明

  例: fm_1914_description
• fppServer: string
  isFppImageがtrueの場合、このフィールドにはイメージが存在するFPPサーバー名が含まれます

  例: xyz0102c
• fppUser: string
  isFppImageがtrueの場合、このフィールドにはイメージへのアクセス権を持つFPPユーザー名が含まれます

  例: restuser
• id: string
  イメージのID

  例: E6C5858BD2B46B37E05380FE4564A69B
• isFppImage: boolean
  FPPイメージを示すフラグ

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

  例: fm_1914image
• platformName: string
  イメージのプラットフォーム

  例: Linux x86-64
• timeCreated: string (date-time)
  イメージの作成時間

  例: 2022-08-22 00:10:27.0
• version: string
  イメージのバージョン

  例: 19.0.0.0.0

{
    "description":"Common image summary",
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of the image",
            "type":"string",
            "example":"fm_1914image"
        },
        "id":{
            "description":"ID of the image",
            "type":"string",
            "example":"E6C5858BD2B46B37E05380FE4564A69B"
        },
        "isFppImage":{
            "description":"Flag to indicate FPP image",
            "type":"boolean",
            "example":true
        },
        "fppServer":{
            "description":"If isFppImage is true then this field contains FPP server name, where the image is present",
            "type":"string",
            "example":"xyz0102c"
        },
        "fppUser":{
            "description":"If isFppImage is true then this field contains FPP user name, who has access to the image",
            "type":"string",
            "example":"restuser"
        },
        "description":{
            "description":"Description of the image",
            "type":"string",
            "example":"fm_1914_description"
        },
        "version":{
            "description":"Version of the image",
            "type":"string",
            "example":"19.0.0.0.0"
        },
        "platformName":{
            "description":"Platform of the image",
            "type":"string",
            "example":"Linux x86-64"
        },
        "timeCreated":{
            "description":"Creation time of the image",
            "type":"string",
            "format":"date-time",
            "example":"2022-08-22 00:10:27.0"
        },
        "createdBy":{
            "description":"Owner of the image",
            "type":"string",
            "example":"ADMIN"
        },
        "links":{
            "type":"object",
            "description":"Navigation links",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/SelfLink"
                }
            }
        }
    }
}

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

型: object

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

ソースの表示

• imageVersions: array imageVersions
  削除の候補であるイメージ・バージョンの配列
• message: string
  イメージを削除できるかどうかを示すメッセージ

  例: If the image does not have subscriptions then the message is "The following versions are candidates for deletion." else the message is "The image has active subscriptions hence cannot be deleted. Please delete all subscriptions or use force option to delete the image and following versions are candidate for deletion"

{
    "description":"Delete gold image report",
    "type":"object",
    "properties":{
        "message":{
            "description":"Message indicates whether the image can be deleted",
            "type":"string",
            "example":"If the image does not have subscriptions then the message is \"The following versions are candidates for deletion.\" else the message is \"The image has active subscriptions hence cannot be deleted.Please delete all subscriptions or use force option to delete the image and following versions are candidate for deletion\""
        },
        "imageVersions":{
            "description":"Array of the image versions, which are candidates for deletion",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DeletableGoldImageVersionCandidate"
            }
        }
    }
}

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

型: object

ナビゲーション・リンク

ソースの表示

• self: object SelfLink
  セルフリンクを表します

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

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

型: object

セルフリンクを表します

ソースの表示

• href: string
  セルフリンクのURL

  例: /em/api/<resources>/<resourceId>

{
    "type":"object",
    "description":"Represents a self-link",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the self-link",
            "example":"/em/api/<resources>/<resourceId>"
        }
    }
}

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

型: array

削除の候補であるイメージ・バージョンの配列

ソースの表示

• 配列: object DeletableGoldImageVersionCandidate
  ゴールド・イメージ/バージョンの安全な削除に関する情報

{
    "description":"Array of the image versions, which are candidates for deletion",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DeletableGoldImageVersionCandidate"
    }
}

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

型: 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
• name: string
  イメージ・バージョンの名前

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

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

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

{
    "description":"Information on safe delete gold 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"
        },
        "externalId":{
            "description":"External ID of the image version",
            "type":"string",
            "example":"oracle:defaultService:em:provisioning:1:cmp:COMP_Component:SUB_OracleDB:4BAFA861A7E96603E053057FB10A0588:0.1"
        },
        "position":{
            "description":"Position of a 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"
        }
    }
}

例

例の選択 ペイロード

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

先頭に戻る