移動

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

インスタンスのパッチの詳細の取得

get

/api/v1/blockchainPlatforms/instances/{id}/patch

インスタンスのパッチの詳細を取得します。

リクエスト

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

• application/json

パス・パラメータ

• id: string
  プラットフォーム・インスタンスの一意の識別子

問合せパラメータ

• type: string
  インスタンスのパッチのタイプ: Applied、AvailableまたはAll。AllにはAppliedとAvailableが含まれます。

  許容値: [ "Applied", "Available", "All" ]

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: InstancePatchInfoSummary

型: object

ソースの表示

• applied(オプション): array applied
• available(オプション): array available

{
    "type":"object",
    "properties":{
        "available":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PatchInfoSummary"
            }
        },
        "applied":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PatchInfoSummary"
            }
        }
    }
}

ネストしたスキーマ: applied

型: array

ソースの表示

• 配列: object PatchInfoSummary

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

ネストしたスキーマ: available

型: array

ソースの表示

• 配列: object PatchInfoSummary

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

ネストしたスキーマ: PatchInfoSummary

型: object

ソースの表示

• applicable(オプション): boolean
  パッチが適用可能かどうか
• description(オプション): string
  パッチの説明または詳細
• displayName(オプション): string
  パッチの表示名
• fullVersion(オプション): string
  パッチの完全バージョン
• patchId(オプション): string
  パッチのID
• prevVersion(オプション): string
  前のバージョン
• release(オプション): string
  パッチ・リリース・バージョン
• rollbackable(オプション): boolean
  パッチをロールバックできるかどうか
• serviceVersion(オプション): string
  パッチ・サービス・バージョン
• status(オプション): string
  パッチ/ロールバック・ステータス

{
    "type":"object",
    "properties":{
        "patchId":{
            "type":"string",
            "description":"Patch ID"
        },
        "displayName":{
            "type":"string",
            "description":"Patch display name"
        },
        "description":{
            "type":"string",
            "description":"Patch description or details"
        },
        "serviceVersion":{
            "type":"string",
            "description":"Patch service version"
        },
        "release":{
            "type":"string",
            "description":"Patch release version"
        },
        "fullVersion":{
            "type":"string",
            "description":"Patch full version"
        },
        "prevVersion":{
            "type":"string",
            "description":"Previous version"
        },
        "rollbackable":{
            "type":"boolean",
            "description":"Is patch able to be rolled back"
        },
        "applicable":{
            "type":"boolean",
            "description":"Is patch able to be applied"
        },
        "status":{
            "type":"string",
            "description":"Patch/rollback status"
        }
    }
}

401レスポンス

未認可

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array warnings
  警告のリスト

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

404レスポンス

見つかりません

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array warnings
  警告のリスト

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array warnings
  警告のリスト

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

先頭に戻る

例

このエンドポイントは、インスタンス・パッチの詳細を取得するために使用されます。

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行し、インスタンス・パッチの詳細を問い合せて取得する方法を示しています。

curl -X GET http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/56cda494-e776-416e-a2fa-c7e2a95955b8/patch?type=All 
-H 'Authorization: Basic amFzc2l0ZXN0OndlbGNvbWUx'

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
  "available" : [ ],
  "applied" : [ {
    "patchId" : "obp-patch-19-3-3",
    "displayName" : "OBP Patch 19.3.3",
    "description" : "OBP Patch 19.3.3",
    "serviceVersion" : "19.3",
    "release" : "3",
    "fullVersion" : "19.3.3",
    "prevVersion" : "19.3.2",
    "rollbackable" : true,
    "applicable" : null,
    "status" : "Applied"
  } ]
}

先頭に戻る