REST APIリファレンス

前へ次へ

メータリングデータのエクスポートジョブのステータスの取得

GET要求を使用して、メータリングデータのエクスポートジョブのステータスを取得します。

GET要求

エクスポートジョブのステータスを取得するには、次のいずれかのURIを使用します。

/public/core/v3/license/metering/ExportMeteringData/<jobId>

GET応答

応答には次のフィールドが含まれます。

フィールド	タイプ	説明
jobID	String	エクスポートジョブのID。
status	String	エクスポートジョブのステータス。次のいずれかの値が返されます。 CREATED PROCESSING SUCCESS FAILED PARTIAL_SUCCESS ステータスがPARTIAL_SUCCESSの場合、ジョブは完了しましたが、エラーにより、リンクされた一部の組織のデータは収集できませんでした。
errorMessage	String	ジョブに関連付けられているエラーメッセージ（存在する場合）。
orgId	String	要求元の組織の組織ID。
userId	String	要求を送信したユーザーのID。
selectedOrgId	String	要求元の組織の組織ID。
meterId	String	メーターID。ジョブレベルの詳細を要求するジョブに適用されます。
startDate	日付/時刻	日付範囲の開始日。
endDate	日付/時刻	日付範囲の終了日。
callbackUrl	String	サービスがジョブステータスを送信するために使用するURL。
createTime	String	エクスポートジョブが作成された時刻。
updateTime	String	エクスポートジョブが最後に更新された時刻。

GET応答の例

成功した場合、次の例のような応答を受信します。

{
    "jobId": "4l1eKlA9ngChmu6gdv3FKs",
    "status": "SUCCESS",
    "orgId": "4wMFqGlxAKVlIFTixlTSOY",
    "userId": "aMxRLnYzdWtlkJvDbtPZOr",
    "selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY",
    "meterId": null,
    "startDate": "2022-08-01T10:00:00Z",
    "endDate": "2022-12-31T00:00:00Z",
    "callbackUrl": "https://MyExportJobStatus.com",
    "createTime": "2022-11-23T10:04:37Z",
    "updateTime": "2022-11-23T10:04:37Z"
}

ジョブが部分的に成功した場合、応答は次の例のようになります。


{
    "jobId": "cYjwJNEF7OckWEmkSC1tSI",
    "status": "PARTIAL_SUCCESS",
    "errorMessage": "Short error message: [fetchEligibleJobForExecution] Exception in executing
job. org.springframework.web.client.HttpServerErrorException$ServiceUnavailable: 503 Service
Unavailable: \"<html><body><h1>503 Service Unavailable</h1><EOL>No server is available to handle
this request.<EOL></body></html><EOL>\",
    "orgId": "4wMFqGlxAKVlIFTixlTSOY",
    "userId": "aMxRLnYzdWtlkJvDbtPZOr",
    "selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY",
    "meterId": null,
    "startDate": "2020-01-01T10:00:00Z",
    "endDate": "2022-12-31T00:00:00Z",
    "callbackUrl": "https://MyExportJobStatus.com",
    "createTime": null,
    "updateTime": null
}

メータリングデータ

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal