ジャンプ先

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

特定のフリート・パッチ適用およびプロビジョニング・クライアントの詳細を取得します。

GET

/rhp-restapi/rhp/clients/{clientId}

リクエスト

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

• application/json

パス・パラメータ

• clientId(必須): string
  クライアント・クラスタの名前。

問合せパラメータ

• detail: boolean
  クラスタのクラスタ情報(HTML)を生成します。
• node: string
  リモート・クラスタ内のノードの名前を指定します。

セキュリティ

• basicAuthentication: basic
  タイプ: Basic

先頭に戻る

レスポンス

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

• application/json
• text/html

200 レスポンス

OK。少なくともIdプロパティを持つ0個以上の要素が移入された"items"プロパティと、少なくとも"self"リンクを持つlinks配列を含むJSONオブジェクト。

Body ()

ルート・スキーマ: arrayOfItems

タイプ: object

ソースの表示

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResource"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: オブジェクト singleResource

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

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

タイプ: object

ソースの表示

• links: array links
• resourceId: string

{
    "type":"object",
    "properties":{
        "resourceId":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/singleResourceLinks"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: オブジェクト singleResourceLinks

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

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

先頭に戻る