移動

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

ターゲット・インスタンスへのパッチの適用

post

/api/v1/blockchainPlatforms/patches/{patchId}/apply

1つ以上のターゲット・インスタンスにパッチを適用します。

リクエスト

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

• application/json

パス・パラメータ

• patchId: string
  一意のパッチ識別子

本文()

パッチを適用するターゲット・インスタンスのIDのリスト

ルート・スキーマ: PatchApplyPayload

型: array

パッチ・ターゲット・インスタンスのIDのリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"List of patch target instance IDs",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

• application/json

202レスポンス

受理

本文()

ルート・スキーマ: PatchApplySummary

型: object

ソースの表示

• applyStatus(オプション): array applyStatus
  すべてのターゲットのパッチ適用リクエスト・ステータス
• patchId(オプション): string
  適用されたパッチID

{
    "type":"object",
    "properties":{
        "patchId":{
            "type":"string",
            "description":"Patch ID that was applied"
        },
        "applyStatus":{
            "type":"array",
            "description":"Patch application request status for all targets",
            "items":{
                "$ref":"#/definitions/PatchApplyStatus"
            }
        }
    }
}

ネストしたスキーマ: applyStatus

型: array

すべてのターゲットのパッチ適用リクエスト・ステータス

ソースの表示

• 配列: object PatchApplyStatus

{
    "type":"array",
    "description":"Patch application request status for all targets",
    "items":{
        "$ref":"#/definitions/PatchApplyStatus"
    }
}

ネストしたスキーマ: PatchApplyStatus

型: object

ソースの表示

• instanceId(オプション): string
  パッチが適用されたインスタンスのID
• instanceName(オプション): string
  パッチが適用されたインスタンスの表示名
• status(オプション): string
  許容値: [ "Success", "Failure" ]

  パッチ適用リクエスト・ステータス
• statusMessage(オプション): string
  パッチのステータス・メッセージ
• statusURL(オプション): string
  パッチ・リクエスト・ステータスURL

{
    "type":"object",
    "properties":{
        "instanceId":{
            "type":"string",
            "description":"Patch applied instance ID"
        },
        "instanceName":{
            "type":"string",
            "description":"Patch applied instance display name"
        },
        "status":{
            "type":"string",
            "description":"Patch application request status",
            "enum":[
                "Success",
                "Failure"
            ]
        },
        "statusURL":{
            "type":"string",
            "description":"Patch request status URL"
        },
        "statusMessage":{
            "type":"string",
            "description":"Patch status message"
        }
    }
}

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

409レスポンス

操作の競合

本文()

ルート・スキーマ: 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"
    }
}

先頭に戻る

例

このエンドポイントは、1つ以上のターゲット・インスタンスにパッチを適用するために使用されます。

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行し、1つ以上のターゲット・インスタンスにパッチを適用する方法を示しています。

curl -X POST http://<hostname>:<port>/api/v1/blockchainPlatforms/patches/obp-patch-19-3-3/apply 
-H 'Authorization: Basic amFzc2l0ZXN0OndlbGNvbWUx' 
-H  'Content-Type: application/json' 
-d '["e1f7bcfe-cc7e-4d19-97fb-772b231fcf99"]'

レスポンス本文の例

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

{
  "patchId" : "obp-patch-19-3-3",
  "applyStatus" : [ {
    "instanceId" : "e1f7bcfe-cc7e-4d19-97fb-772b231fcf55",
    "instanceName" : "JasFounder",
    "status" : "Success",
    "statusURL" : "http://myvm.oracle.com:7070/api/v1/blockchainPlatforms/instances/56cda494-e776-416e-a2fa-c7e2a95955b8/operation/IDp6T6cqcEOUe8XMJEpHi4S2PnYCY6xGkuPazlGAGM9C8=/status"
  } ]
}

先頭に戻る