REST APIリファレンス

前へ次へ

IPU使用率データのエクスポートジョブ要求の送信

指定された日付範囲の親組織と、追加プロダクション組織、サブ組織、およびサンドボックス組織などのリンクされた組織のサマリIPU使用率データをエクスポートするジョブを実行できます。

ジョブの開始後、ジョブのステータスを確認できます。ジョブが正常に完了した後に、データをダウンロードする要求を送信できます。

POST要求

サマリIPU使用率データを要求して受信するには、親組織およびリンクされたすべての組織へのアクセス権が必要です。

エクスポートジョブ要求を送信するには、次のURIを使用します。

/public/core/v3/license/metering/ExportMeteringDataAllLinkedOrgsAcrossRegion

要求に次のフィールドを含めます。

フィールド	タイプ	必須	説明
startDate	日付/時刻	○	日付範囲の開始日。
endDate	日付/時刻	○	日付範囲の終了日。範囲は最大180日です。
combinedMeterUsage	Boolean	-	すべてのメーターの使用状況情報を1つのCSVファイルで返すかどうかを示します。次のいずれかの値を含めます。 TRUE。すべてのメーターの使用状況情報を1つのCSVファイルで返します。 FALSE。メーターごとに使用状況情報を個別のCSVファイルで返します。デフォルトはFALSEです。
callbackUrl	String	-	公表済みの有効なURL。サービスがcallbackURLにジョブステータスをポストします。

POST要求の例

次の例のような要求を使用できます。

POST <baseApiUrl>/public/core/v3/license/metering/ExportMeteringDataAllLinkedOrgsAcrossRegion
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

{
    "startDate":"2022-08-12T00:00:00Z",
    "endDate":"2022-10-25T00:00:00Z",
    "combinedMeterUsage":"FALSE"
    "callbackUrl":"https://MyExportJobStatus.com"
}

POST応答

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

フィールド	タイプ	説明
jobID	String	エクスポートジョブのID。
status	String	エクスポートジョブのステータス。
errorMessage	String	ジョブに関連付けられているエラーメッセージ（存在する場合）。
orgId	String	要求元の組織の組織ID。
userId	String	要求を送信したユーザーのID。
selectedOrgId	String	要求元の組織の組織ID。
startDate	日付/時刻	日付範囲の開始日。
endDate	日付/時刻	日付範囲の終了日。
callbackUrl	String	サービスがジョブステータスを送信するために使用するURL。
createTime	String	エクスポートジョブが作成された時刻。
updateTime	String	エクスポートジョブが最後に更新された時刻。
combinedMeterUsage	Boolean	すべてのメーターの使用状況データを1つのCSVファイルで返すかどうかを示します。

POST応答の例

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

{
    "jobId": "cYjwJNEF7OckWEmkSC1tSI",
    "status": "CREATED",
    "orgId": "4wMFqGlxAKVlIFTixlTSOY",
    "userId": "aMxRLnYzdWtlkJvDbtPZOr",
    "selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY",
    "startDate": "2020-01-01T10:00:00Z",
    "endDate": "2022-12-31T00:00:00Z",
    "callbackUrl": "https://MyExportJobStatus.com",
    "createTime": null,
    "updateTime": null
    "combinedMeterUsage":"FALSE"
}

エラーが発生した場合、応答は次の例のようになります。

{
    "jobId": "cYjwJNEF7OckWEmkSC1tSI",
    "status": "FAILED",
    "errorMessage": "Exception occurred while processing request for org:
4wMFqGlxAKVlIFTixlTSOY.\ncom.informatica.cloud.errorutil.MicroServiceException: Get
meter usage request failed with exception: I/O error on POST request",
    "orgId": "4wMFqGlxAKVlIFTixlTSOY",
    "userId": "aMxRLnYzdWtlkJvDbtPZOr",
    "selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY",
    "startDate": "2020-01-01T10:00:00Z",
    "endDate": "2022-12-31T00:00:00Z",
    "callbackUrl": "https://MyExportJobStatus.com",
    "createTime": null,
    "updateTime": null
    "combinedMeterUsage":"FALSE"
}

メータリングデータ

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal