イメージ更新の再試行

警告: この API ドキュメントは Clanforge 用です。Multiplay Hosting を使用している場合は、Multiplay Hosting API のドキュメント を参照してください。

<updateid> によって識別されたイメージ更新ジョブを再試行します。

https://api.multiplay.co.uk/cfp/v1/imageupdate/<updateid>/retry

メソッド

GET

リクエストパラメーター

変数説明任意
accountserviceid<accountserviceid> パラメーターには、指定されたリソースに関連付けられたアカウントサービス ID (ASID) を指定します。このリクエストを実行するには、リクエストヘッダーの認証情報が ASID へのアクセス権を保持している必要があります。いいえ
updateid<updateid> パラメーターには、更新 ID を指定します。指定された更新 ID が再試行されます。

イメージ更新 ID は、Image Update Create (イメージ更新の作成) エンドポイントから返されます。

いいえ

レスポンスフィールド

フィールド説明任意
updateidinteger更新の IDはい
jobcreatedintegerジョブが作成された時刻の Unix タイムスタンプいいえ
joberrorstringジョブエラーを示すメッセージはい
jobetaintegerジョブの完了予定時刻を表す Unix タイムスタンプはい
jobfailedintegerジョブが失敗したかどうかを示す数値フラグいいえ
jobprogressintegerジョブの進捗を示す 0 - 100 のパーセンテージいいえ
jobstartstringジョブが開始した時刻の Unix タイムスタンプはい
jobstateidintegerジョブの状態を示すジョブ状態 IDはい
jobstatenamestringジョブの状態の名前いいえ
jobupdatedintegerジョブの最終更新日時の Unix タイムスタンプいいえ
successbooleanこのリクエストが成功したかどうかを示すフラグいいえ

リクエストの例

curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/imageupdate/<updateid>/retry?accountserviceid=<accountserviceid>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

レスポンスの例

{
    "updateid": <updateid>,
    "jobcreated": <jobcreated>,
    "joberror": <joberror>,
    "jobeta": <jobeta>,
    "jobfailed": <jobfailed>,
    "jobprogress": <jobprogress>,
    "jobstart": <jobstart>,
    "jobstateid": <jobstateid>,
    "jobstatename": <jobstatename>,
    "jobupdated": <jobupdated>
}