ジャンプ先

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

指定したイメージ名の削除

DELETE

/rhp-restapi/rhp/images/{imageId}

指定したイメージ名で表されるゴールド・イメージを削除します。

リクエスト

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

• application/json

パス・パラメータ

• imageId(必須): string
  イメージの名前

先頭に戻る

レスポンス

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

• application/json
• text/html

200 レスポンス

OK。複数のプロパティを持つイメージ・リソース表現と、少なくとも"self"リンクを持つlinks配列を含むJSONオブジェクト。削除が成功した場合のみ。

Body ()

ルート・スキーマ: imageResource

タイプ: object

ソースの表示

• clientName: string
• complete: boolean
• containsNonRollingPatch: boolean
• groupsConfigured: string
• homePath: string
• imageId: string
• imageSize: integer
• imageState: string
• imageType: string
• links: array links
• owner: string
• parentImage: string
• patches: array patches
• platform: string
• roles: array roles
• templateWithDataFiles: array templateWithDataFiles
• templateWithoutDataFiles: array templateWithoutDataFiles
• version: string

{
    "type":"object",
    "properties":{
        "imageId":{
            "type":"string"
        },
        "clientName":{
            "type":"string"
        },
        "roles":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "patches":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "parentImage":{
            "type":"string"
        },
        "homePath":{
            "type":"string"
        },
        "imageState":{
            "type":"string"
        },
        "imageType":{
            "type":"string"
        },
        "imageSize":{
            "type":"integer"
        },
        "version":{
            "type":"string"
        },
        "owner":{
            "type":"string"
        },
        "complete":{
            "type":"boolean"
        },
        "platform":{
            "type":"string"
        },
        "containsNonRollingPatch":{
            "type":"boolean"
        },
        "groupsConfigured":{
            "type":"string"
        },
        "templateWithDataFiles":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "templateWithoutDataFiles":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResourceLinks"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: オブジェクト singleResourceLinks

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/singleResourceLinks"
    }
}

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

タイプ: array

ソースの表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

タイプ: array

ソースの表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

タイプ: array

ソースの表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

タイプ: array

ソースの表示

• 配列: 文字列

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

タイプ: object

ソースの表示

• href: string
  絶対形式で指定された参照ハイパーリンク要素。
• rel: string
  指定できる値: [ "self", "collection", "up", "describedBy" ]

  説明されたリソースを持つリンクの関係のタイプを指定します。

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Specify the type of relationship the link has with the described resource.",
            "enum":[
                "self",
                "collection",
                "up",
                "describedBy"
            ]
        },
        "href":{
            "type":"string",
            "description":"The referenced hyperlink element provided in an absolute format."
        }
    }
}

デフォルト・レスポンス

予期しないエラー操作の実行中の問題のエラー詳細を含むJSONオブジェクト。

Body ()

ルート・スキーマ: errorResource

タイプ: object

ソースの表示

• errorCode: string
  tittleに表示されるエラー・メッセージに関連する、アプリケーション固有のエラー・コード。
• errorDetails: array errorDetails
  複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。
• errorPath: string
  エラーの発生場所を示すXPathまたはJSONパス。
• instance: string
  エラーに関する詳細を提供するリンクへのURI。
• status: integer
  HTTPステータス・コード。
• title: string
  要約エラー・メッセージ。
• type: string
  HTTPエラー・コード・ページへのリンク。

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer",
            "description":"HTTP status code."
        },
        "type":{
            "type":"string",
            "description":"Link to HTTP error code page."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorDetails":{
            "type":"array",
            "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
            "items":{
                "$ref":"#/definitions/errorResource"
            }
        },
        "errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code, related to the error message shown at tittle."
        }
    }
}

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

タイプ: array

複数のエラーがレポートされている場合は、この配列の階層構造に編成できます。

ソースの表示

• 配列: オブジェクト errorResource

{
    "type":"array",
    "description":"If multiple errors are reported they can be organized in a hierarchical structure in this array.",
    "items":{
        "$ref":"#/definitions/errorResource"
    }
}

先頭に戻る

例

次の例は、cURLを使用してRESTリソースにDELETEリクエストを発行することで、フリート・パッチ適用およびプロビジョニング・サーバーからゴールド・イメージを削除する方法を示しています。

curl -u restUser -X DELETE "https://RHP_node_name:8894/rhp-restapi/rhp/images/DB_Image1"

HTTPステータス・コードとレスポンス・ヘッダー

レスポンス・ヘッダーの例を次に示します。

HTTP/1.1 202
Location: https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,PUT,POST,DELETE,PATCH,OPTIONS
Access-Control-Allow-Headers: X-Requested-With, Content-Type, Content-Length, Authorization
Connection: keep-alive
Content-Type: application/json
Content-Length: 159
Date:  Tue, 19 Jun 2018 14:03:23 GMT

レスポンス本体

{
     "links": [{
         "uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
         "rel": "self"
      }],
     "jobId": "1",
     "output": {  }
}

先頭に戻る