フリート・パッチ適用およびプロビジョニング用のREST API

ジョブ詳細の取得

GET

/rhp-restapi/rhp/jobs/{jobId}

指定されたジョブIDに関連付けられたジョブ・リソースの構成を返します。

リクエスト

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

application/json

パス・パラメータ

jobId(必須): string

スケジュール済ジョブの一意の整数ジョブID値。

先頭に戻る

レスポンス

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

application/json
text/html

200 レスポンス

OK。複数のプロパティを持つジョブ・リソース表現と、少なくとも"self"リンクを持つlinks配列を含むJSONオブジェクト。

ルート・スキーマ: jobResource

タイプ: object

ソースの表示

jobId: string
links: array links
operation: string
output: object jobOutputResource
status: string

指定できる値: [ "SCHEDULED", "UNKNOWN", "EXECUTING", "PAUSED", "ABORTED", "TERMINATED", "FAILED", "SUCCEEDED" ]

{
    "type":"object",
    "properties":{
        "jobId":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "SCHEDULED",
                "UNKNOWN",
                "EXECUTING",
                "PAUSED",
                "ABORTED",
                "TERMINATED",
                "FAILED",
                "SUCCEEDED"
            ]
        },
        "operation":{
            "type":"string"
        },
        "output":{
            "$ref":"#/definitions/jobOutputResource"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResourceLinks"
            }
        }
    }
}

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

タイプ: array

ソースの表示

配列: オブジェクト singleResourceLinks

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

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

タイプ: object

ソースの表示

hasMore: boolean

デフォルト値: false
limit: integer
links: array links
offset: integer
output: string

{
    "type":"object",
    "properties":{
        "output":{
            "type":"string"
        },
        "limit":{
            "type":"integer"
        },
        "offset":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/collectionResourceLinks"
            }
        }
    }
}

ネストされたスキーマ: 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."
        }
    }
}

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

タイプ: array

ソースの表示

配列: オブジェクト collectionResourceLinks

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

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

タイプ: object

ソースの表示

href: string

正しいURLパラメータを持つ絶対形式で指定された参照ハイパーリンク要素。
rel: string

指定できる値: [ "next", "prev", "first", "last" ]

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

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Specify the type of relationship the link has with the described resource.",
            "enum":[
                "next",
                "prev",
                "first",
                "last"
            ]
        },
        "href":{
            "type":"string",
            "description":"The referenced hyperlink element provided in an absolute format with the correct URL parameters."
        }
    }
}

デフォルト・レスポンス

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

ルート・スキーマ: 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リソースにGETリクエストを発行することによって、既存のジョブの詳細を表示する方法を示しています。

curl -u restUser -X GET "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1"

レスポンス・ヘッダー

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

HTTP/1.1 200
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: 321
Date:  Tue, 19 Jun 2018 14:03:23 GMT

レスポンス本体

{
     "links": [{
         "uri": "https://RHP_node_name:8894/rhp-restapi/rhp/jobs/1",
         "rel": "self"
      }],
     "status": "SCHEDULED",
     "jobId": "1",
     "output": {  },
     "operation": "importIntoImage{image=DB_Image1, schedule=2018-06-14T15:42:38Z, path=/path/to/software/home/being/imported/esw1}"
}

先頭に戻る