Oracle Enterprise ManagerのREST API

イメージ・バージョンの削除

delete

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

指定されたバージョンのイメージを削除します。FPPベースのバージョンのイメージの場合、これは、タスクを実行するデプロイメント・プロシージャを発行する非同期操作です。FPPベースのバージョンのイメージを削除するには、FPP RESTユーザー資格証明が必要です。

リクエスト

パス・パラメータ

goldImageId(必須): string

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

イメージ・バージョンのID

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

application/json

ルート・スキーマ: schema

すべてに一致

ソースの表示

object DeleteImageInput

ゴールド・イメージの削除オプション

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DeleteImageInput"
        }
    ]
}

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

型: object

ゴールド・イメージの削除オプション

ソースの表示

fppRestUser: string

FPP RESTコールに使用されるRESTユーザー

例: rest_cuser
isForce: boolean

ターゲットがサブスクライブされている場合でも削除を強制するフラグ

{
    "description":"Delete gold image option",
    "type":"object",
    "properties":{
        "isForce":{
            "description":"Flag to force delete even if targets are subscribed",
            "type":"boolean"
        },
        "fppRestUser":{
            "description":"REST user to be used for an FPP REST call",
            "type":"string",
            "example":"rest_cuser"
        }
    }
}

先頭に戻る

レスポンス

202レスポンス

長時間実行/非同期APIです。FPPイメージを削除するためのデプロイメント・プロシージャを発行します。

ヘッダー

Location:
デプロイメント・プロシージャのAPIのステータスを追跡するためのURLリンク
例:
```
/deploymentProcedureInstances/{deploymentProcedureInstanceId}
```

ルート・スキーマ: schema

型: object

ソースの表示

links: object links

リンク
message: string

メッセージ

例: It is a long running/async API. It submits a deployment procedure for deletion of an FPP image.

{
    "type":"object",
    "properties":{
        "message":{
            "description":"message",
            "type":"string",
            "example":"It is a long running/async API. It submits a deployment procedure for deletion of an FPP image."
        },
        "links":{
            "description":"links",
            "type":"object",
            "properties":{
                "tracking":{
                    "type":"object",
                    "description":"Represents the link to REST API to track the status of the submitted deployment procedure",
                    "properties":{
                        "href":{
                            "type":"string",
                            "description":"URL for the Link",
                            "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
                        }
                    }
                }
            }
        }
    }
}

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

型: object

リンク

ソースの表示

tracking: object tracking

発行されたデプロイメント・プロシージャのステータスを追跡するためのREST APIへのリンクを表します

{
    "description":"links",
    "type":"object",
    "properties":{
        "tracking":{
            "type":"object",
            "description":"Represents the link to REST API to track the status of the submitted deployment procedure",
            "properties":{
                "href":{
                    "type":"string",
                    "description":"URL for the Link",
                    "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
                }
            }
        }
    }
}

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

型: object

発行されたデプロイメント・プロシージャのステータスを追跡するためのREST APIへのリンクを表します

ソースの表示

href: string

リンクのURL

例: /deploymentProcedureInstances/{deploymentProcedureInstanceId}

{
    "type":"object",
    "description":"Represents the link to REST API to track the status of the submitted deployment procedure",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for the Link",
            "example":"/deploymentProcedureInstances/{deploymentProcedureInstanceId}"
        }
    }
}

204レスポンス

コンテンツなし。これはネイティブのフリート・ゴールド・イメージ・バージョン削除のレスポンスです

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

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

先頭に戻る