バッチファイルのアップロード状態を取得する

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

GET /v2/batches/{:placeholder-token:}<batchRef>{/:placeholder-token:}

アップロードを開始したバッチファイルの現在のアップロードステータスを取得します。

次のファイルをアップロードする前に、ファイルのアップロードステータスが成功したことを確認することをお勧めします。これにより、ファイルのステータスを確認せず、フォーマットの問題やその他のエラーが原因で失敗したことに気付いた場合に、ファイルを再度アップロードする必要がなくなります。

応答で、ステータスがerrorの場合、statusオブジェクトにはlogキーが含まれています。 logキーには、エラーログのURIが含まれています。エラーログのURIを使用して、エラーログを取得し、アップロードプロセスのトラブルシューティングを行います。

属性	種類	形容	例
{:placeholder-token:}batchRef{/:placeholder-token:}	糸	バッチアップロードのUUID。バッチアップロードの場所を割り当てたときに生成したものと同じUUIDを使用します。	12af3453-62da-4b31-b646-631b7b5f3009

属性

種類

形容

例

{:placeholder-token:}batchRef{/:placeholder-token:}

糸

バッチアップロードのUUID。

バッチアップロードの場所を割り当てたときに生成したものと同じUUIDを使用します。

12af3453-62da-4b31-b646-631b7b5f3009

応答本文には、次のフィールドを含めることができます。

属性	形容	種類
href	このリクエストで使用されたURLをエコーバックします。	糸
ref	バッチのUUIDは、hrefの一部を形成します。	糸
checksum	アップロードするファイルのチェックサムをエコーバックします。	糸
size	アップロードするファイルのサイズをエコーバックします。	整数
location	ファイルのアップロード場所の詳細。	オブジェクト
location.href	バッチファイルのアップロード先に割り当てられたURL。このURLは1時間有効です。	糸
location.expiry	アップロード場所hrefの有効期限が切れる日時。	日時
status	ファイルのアップロードのステータス。	オブジェクト
status.code	バッチ・ファイル処理の状況。可能な値: uploading - インポートプロセスがクライアントによって初期化されました。 processing - インポートファイルをアップロードし、処理を開始しました。 success - インポートファイルが正常に処理されました。 corrupted - インポートファイルがチェックサムと一致しませんでした。 error - インポートに失敗しました。ログファイルを参照してください。ログ・ファイルの場所は、status.logパラメーターの値です。	糸
status.log	バッチ・アップロード・リクエストにエラーが含まれている場合は、エラーの詳細を含むログ・ファイルの場所。	糸
summaryStats	ファイルのアップロードに関する統計の概要が含まれます。	オブジェクト
summaryStats.timeToProcessMillis	バッチインポートジョブの実行にかかった時間 (ミリ秒単位)。	整数
summaryStats.totalCount	バッチ・インポート・ジョブによってインポート・ファイルから読み取られたレコードの合計数。	整数
summaryStats.succeededCount	バッチインポートジョブが正常に処理されたレコードの数。	整数
summaryStats.failedCount	バッチ・インポート・ジョブが処理に失敗したレコードの数。	整数
createdAt	リクエストが作成された日時。	日時
modifiedAt	リクエストが最後に更新された日時。	日時

curl -X GET '<baseURL>/v2/batches/12af3453-62da-4b31-a646-631b7b5f3009' \
-u '<username>:<password>' \
-H 'Accept: application/json'

ステータス: uploading:

{
    "href": "<baseURL>/v2/batches/12af3453-62da-4b31-b646-631b7b5f3009",
    "ref": "12af3453-62da-4b31-b646-631b7b5f3009",
    "checksum": "b1d600dbf7463924e24647e626cd7c1e",
    "size": 227,
    "location": {
        "href": "https://sitecore-batch-service-production-eu-west-1.s3.eu-west-1.amazonaws.com/pqsTELpfrXBzxKozB0IoL4xuAT0s7WrH/12af3453-62da-4b31-b646-631b7b5f3009/import.gz?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEDAaCWV1LXdlc3QtMSJIMEYCIQCvLllsVnScVKunabp2ecWZ35wWC2qazGUOH38uZ4ebNwIhAPhKsvrNikvkBSJwFo4Heat72zODcLQCPzh87PRThE8qKtUECIn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQABoMNDkzNDAzOTY5MDY2IgzaKR3yFcEnGvR0NjEqqQQiccx7113xYh5boBVgjPQrzpcCLKgXi563nzp0YRIM52WE1LFEezlLQBEcRl9wo0i5ko5%2F8ne%2BPSFGxkc576fPqkdQzQyX9Ub1PA44pwuFzK%2FZSf9mHS7FRqPvvuxlm7srdkceEJK2VAmoUehfKHzDYhtCkPnZyElYwyeZAK7i6QY8u3WqGVIeGiObjZbhB2Ppq9wwSgfbaz5bUpKPwi6%2F3HRzV60gTURhO%2BOJOrxiuTjF6SKm586HQQizeGKWHlOiJghgO22gaqDlowHDMWuCjkPyk%2Fac1LTXNPFnUlQnbMwnvt7iXSRq6BrpZ7hlxxKZrjLT%2Bb35k4BExmE4XnXS%2BeWiSwNmz74xYtGwBzBjDYJL5KQPJBf%2FmmUqRgCV4xex7f8qtp34F4nLcXC0pRxggkSBBSxm214ubh9j7JZYz5QY8KuGDC9pn%2FeNeqFHaS4B%2FKtkNKzU6YyFmQdiXgFMpK22TpKvDQbeX5%2Bazx2lCqBuIR2MSg8xaVxfVOm14tu0WrqIY8luKV9Vpl23LWs713xhg80XwjkUb1nCOu57Lu0hOODrq1lr21CmJWnU7pttLa6fgT2Sineu%2BwkXeTQuVVBfYOw%2BQgyu6yX7hSkskKFMJPSSvSDgcx%2B0z7ze%2F6wwDfc2j94FtriCv77t7RIN1UQYi4%2FWT%2BH1UtqoHEjwf%2B4WUV4sGnzYnWVVNS9D%2FDuhfIcxMtX%2FeC6GY2xl3DaoInj4Dpn%2F%2B%2B%2BDMJy29J0GOqgBLYwZ%2BS6LeU8LGjYX9awM1lZICDgrQ0hlOV350Z6dYGfgRriIVxT3a1tcWbIoa3i2xkJhWKoJlEjgplRBSMEKhYaLbb9OQjKayNjAfDHGNDGr3%2FeGWuhg7SXAXHa1fs1%2BDqeErCylLFgS3TzFH2D7uTNCiSa6z2QS47PQ5lCYhjWqx9odsrCOmAKTrg23disfNZOaHKnlZaug2Yn7zDgbNneWs%2FKjX5GX&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230110T083848Z&X-Amz-SignedHeaders=content-md5%3Bhost%3Bx-amz-server-side-encryption&X-Amz-Expires=3600&X-Amz-Credential=ASIAXFYJLCYVPNLGNNGA%2F20230110%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=00adb6369887346dafc2fdce630f1527ab9482fb2307c921d2850b0d09c0aace",
        "expiry": "2025-01-10T09:38:48.910Z"
    },
    "status": {
        "code": "uploading"
    },
    "createdAt": "2025-01-10T08:38:48.910Z",
    "modifiedAt": "2025-01-10T08:38:49.000Z"
}

ステータス: error:

{  
   "href":"<baseURL>/v2/batches/3ee694e5-0b77-2d1e-af19-1aa78f500785",
   "ref":"3ee694e5-0b77-2d1e-af19-1aa78f500785",
   "checksum":"40d9a12f0a3c93c8ed66a3b6f3735790",
   "size":3456,
   "location":{  
      "href":"https://sitecore-batch-service-dev-eu-west-1.s3.amazonaws.com/xyzsla2xze5vxn02kf283wo020jg/3ee694e5-0b77-2d1e-af19-1aa78f500785/import.gz?AWSAccessKeyId=AKIAI2JLVI7OT2L6QDRQ&Expires=1459953714&Signature=yIG7nFv5w%2B2N%2Fkz11Eh7BjqSt2U%3D",
      "expiry":"2025-04-24T09:33:00.770Z"
   },
   "status":{  
      "code":"error",
      "log":"https://sitecore-batch-service-dev-eu-west-1.s3.amazonaws.com/xyzsla2xze5vxn02kf283wo020jg/3ee694e5-0b77-2d1e-af19-1aa78f500785/import.gz?AWSAccessKeyId=AKIAI2JLVI7OT2L6QDRQ&Expires=1459953714&Signature=yIG7nFv5w%2B2N%2Fkz11Eh7BjqSt2U%3D"
   },
   "summaryStats":{  
      "timeToProcessMillis":614867,
      "totalCount":121776,
      "succeededCount":121460,
      "failedCount":316
   },
   "createdAt":"2025-04-24T08:33:00.770Z",
   "modifiedAt":"2025-04-24T08:46:04.000Z"
}

この記事を改善するための提案がある場合は、お知らせください!

バッチ ファイルのアップロード状態を取得する

バッチファイルのアップロード状態を取得する