メータリングデータ
組織にIntelligent Cloud Data Management機能がある場合は、REST APIを使用してメータリング使用率データをダウンロードできます。
メータリングデータをダウンロードするには、エクスポートジョブ要求を送信し、ジョブの状態を確認してから、データを含むZIPファイルをダウンロードします。
以下のデータをダウンロードできます。
- サマリIPU使用率データ
- 指定された日付範囲における、プロダクション組織、追加プロダクション組織、サブ組織、およびサンドボックス組織のサマリIPU使用率データをダウンロードできます。ZIPファイルには、要求元の組織とその配下の組織のデータが含まれています。
- 例えば、要求元の組織がプロダクション組織である場合、ZIPファイルには、プロダクション組織とその追加プロダクション組織、サブ組織、およびサンドボックス組織のデータが含まれます。要求元の組織がサブ組織を持つ追加プロダクション組織である場合、ZIPファイルには追加プロダクション組織とそのサブ組織のデータが含まれます。
- すべての組織の使用状況情報は、1つのCSVファイルで要求するか、組織ごとに個別のCSVファイルを受け取ることができます。
- プロジェクトレベルの詳細
- 指定した日付範囲のプロジェクトおよびフォルダごとにメータリングデータをダウンロードできます。
- デフォルトでは、ZIPファイルには要求元の組織のデータのみが含まれます。要求元の組織とそのサブ組織のデータの受信を要求することもできます。
- すべての組織の使用状況情報は、1つのCSVファイルで要求するか、組織ごとに個別のCSVファイルを受け取ることができます。
- アセットレベルの詳細
- 指定した日付範囲のアセット別にメータリングデータをダウンロードできます。要求でメーターIDを指定して、特定のメーターの使用状況情報を受け取ることもできます。
- ジョブレベルの詳細
- サービスがジョブレベルの詳細レポートをサポートしている場合は、指定した日付範囲のジョブレベルの詳細をダウンロードできます。特定のメーターまたはすべてのメーターのジョブレベルの詳細を要求できます。ZIPファイルには、要求元の組織のデータが含まれます。
- 要求でメーターIDを指定して、特定のメーターの使用状況情報を受け取ることもできます。
注: 組織は、最大5つのアクティブなジョブを持つことができます。ステータスがCREATEDまたはPROCESSINGの場合、ジョブはアクティブです。
IPU使用状況データのサマリの要求
指定された日付範囲の親組織と、追加プロダクション組織、サブ組織、およびサンドボックス組織などのリンクされた組織のサマリIPU使用率データをエクスポートするジョブを実行できます。
サマリIPU使用率データを要求して受信するには、親組織およびリンクされたすべての組織へのアクセス権が必要です。
ジョブの開始後、ジョブのステータスを確認できます。詳細については、「
メータリングデータのエクスポートジョブのステータスの取得」を参照してください。
ジョブが正常に完了した後に、データをダウンロードする要求を送信できます。データファイルには、次のようなカラムが含まれています。
- •OrgId
- •MeterId
- •MeterName
- •日付
- •BillingPeriodStartDate
- •BillingPeriodEndDate
- •MeterUsage
- •IPU
- •スカラ
- •MetricCategory
- •OrgName
- •OrgType
- •IPURate
注: IPU使用率のサマリデータを要求するために使用できるREST APIリソースは2つあります。これらのリソースは同じデータを返します。
新しいREST APIリソースでのサマリデータの要求
すべての新しいエクスポート要求には、ExportMeteringDataリソースを使用します。
POST要求
エクスポートジョブ要求を送信するには、次のURIを使用します。
/public/core/v3/license/metering/ExportMeteringData
次の表に、要求に含めるフィールドを示します。
フィールド | タイプ | 必須 | 説明 |
|---|
startDate | String | ○ | ISO 8601形式の日付範囲の開始。例: 2022-08-12T00:00:00Z |
endDate | String | ○ | ISO 8601形式の日付範囲の終了。 サマリデータを要求する場合、範囲は最大180日です。 |
jobType | String | ○ | エクスポートするメータリングデータのタイプ。 SUMMARYを使用します。 |
combinedMeterUsage | 文字列 | - | すべての組織の使用状況情報を1つのCSVファイルに返すかどうかを示します。次のいずれかの値を含めます。 - - TRUE。すべての組織の使用状況情報を1つのCSVファイルで返します。
- - FALSE。それぞれの組織の使用状況情報を個別のCSVファイルで返します。
デフォルトはFALSEです。 |
allLinkedOrgs | 文字列 | - | 親組織とそのすべてのリンクされた組織から使用状況情報を返すかどうかを示します。次のいずれかの値を含めます。 - - TRUE。親組織とリンクされたすべての組織の使用状況情報を返します。
- - FALSE。親組織の使用状況情報のみを返します。
デフォルトはFALSEです。 |
callbackUrl | 文字列 | - | サービスがジョブのステータスをポストする、有効かつパブリッシュされたURL。 |
POST要求の例
次の例のような要求を使用できます。
POST <baseApiUrl>/public/core/v3/license/metering/ExportMeteringData
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"startDate":"2024-08-12T00:00:00Z",
"endDate":"2024-09-12T00:00:00Z",
"jobType":"SUMMARY",
"combinedMeterUsage":"TRUE",
"allLinkedOrgs":"TRUE",
"callbackUrl":"https://MyExportJobStatus.com"
}
POST応答
次の表に、応答フィールドを示します。
フィールド | タイプ | 説明 |
|---|
jobID | String | エクスポートジョブのID。 |
status | String | エクスポートジョブのステータス。 |
orgId | String | 要求元の組織の組織ID。 |
userId | String | 要求を送信したユーザーのID。 |
selectedOrgId | String | 要求元の組織の組織ID。 |
meterId | 文字列 | メーターID。 |
startDate | 文字列 | 日付範囲の開始日。 |
endDate | 文字列 | 日付範囲の終了日。 |
callbackUrl | String | サービスがジョブステータスを送信するために使用するURL。 |
createTime | String | エクスポートジョブが作成された時刻。 |
updateTime | String | エクスポートジョブが最後に更新された時刻。 |
POST応答の例
成功した場合、次の例のような応答を受信します。
{
"jobId": "cYjwJNEF7OckWEmkSC1tSI",
"status": "CREATED",
"orgId": "4wMFqGlxAKVlIFTixlTSOY",
"userId": "aMxRLnYzdWtlkJvDbtPZOr",
"selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY",
"meterId": null,
"startDate": "2024-08-12T00:00:00Z",
"endDate": "2024-09-12T00:00:00Z",
"callbackUrl": "https://MyExportJobStatus.com",
"createTime": "2024-09-12T23:22:20Z",
"updateTime": "2024-09-12T23:22:20Z"
}
古いREST APIリソースでのサマリデータの要求
既存のエクスポート要求には、引き続きExportMeteringDataAllLinkedOrgsAcrossRegionリソースを使用できます。
POST要求
エクスポートジョブ要求を送信するには、次のURIを使用します。
/public/core/v3/license/metering/ExportMeteringDataAllLinkedOrgsAcrossRegion
次の表に、要求に含めるフィールドを示します。
フィールド | タイプ | 必須 | 説明 |
|---|
startDate | 日付/時刻 | ○ | 日付範囲の開始日。 |
endDate | 日付/時刻 | ○ | 日付範囲の終了日。 範囲は最大180日です。 |
combinedMeterUsage | Boolean | - | すべての組織の使用状況情報を1つのCSVファイルに返すかどうかを示します。次のいずれかの値を含めます。 - - TRUE。すべての組織の使用状況情報を1つのCSVファイルで返します。
- - FALSE。それぞれの組織の使用状況情報を個別のCSVファイルで返します。
デフォルトはFALSEです。 |
callbackUrl | String | - | サービスがジョブのステータスをポストする、有効かつパブリッシュされたURL。 |
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"
}
プロジェクトレベルのメータリングデータの要求
IPU消費データをプロジェクト別およびフォルダ別にエクスポートするジョブを実行できます。
ジョブの開始後、ジョブのステータスを確認できます。詳細については、「
メータリングデータのエクスポートジョブのステータスの取得」を参照してください。
ジョブが正常に完了した後に、データをダウンロードする要求を送信できます。データファイルには、次のようなカラムが含まれています。
- •日付
- •プロジェクト
- •フォルダー
- •組織ID
- •組織タイプ
- •消費量（IPU）
POST要求
エクスポートジョブ要求を送信するには、次のURIを使用します。
/public/core/v3/license/metering/ExportMeteringData
次の表に、要求に含めるフィールドを示します。
フィールド | タイプ | 必須 | 説明 |
|---|
startDate | String | ○ | ISO 8601形式の日付範囲の開始。例: 2022-08-12T00:00:00Z |
endDate | String | ○ | ISO 8601形式の日付範囲の終了。 プロジェクトレベルのデータを要求する場合、範囲は最大30日間です。 |
jobType | String | ○ | エクスポートするメータリングデータのタイプ。 PROJECT_FOLDERを使用します。 |
combinedMeterUsage | 文字列 | - | すべての組織の使用状況情報を1つのCSVファイルに返すかどうかを示します。次のいずれかの値を含めます。 - - TRUE。すべての組織の使用状況情報を1つのCSVファイルで返します。
- - FALSE。それぞれの組織の使用状況情報を個別のCSVファイルで返します。
デフォルトはFALSEです。 |
allLinkedOrgs | 文字列 | - | 親組織とそのすべてのリンクされた組織から使用状況情報を返すかどうかを示します。次のいずれかの値を含めます。 - - TRUE。親組織とリンクされたすべての組織の使用状況情報を返します。
- - FALSE。親組織の使用状況情報のみを返します。
デフォルトはFALSEです。 |
callbackUrl | 文字列 | - | サービスがジョブのステータスをポストする、有効かつパブリッシュされたURL。 |
POST要求の例
次の例のような要求を使用できます。
{
"startDate":"2024-08-12T00:00:00Z",
"endDate":"2024-09-12T00:00:00Z",
"jobType":"PROJECT_FOLDER",
"combinedMeterUsage":"TRUE",
"allLinkedOrgs":"TRUE",
"callbackUrl":"https://MyExportJobStatus.com"
}
POST応答
次の表に、応答フィールドを示します。
フィールド | タイプ | 説明 |
|---|
jobID | String | エクスポートジョブのID。 |
status | String | エクスポートジョブのステータス。 |
orgId | String | 要求元の組織の組織ID。 |
userId | String | 要求を送信したユーザーのID。 |
selectedOrgId | String | 要求元の組織の組織ID。 |
meterId | 文字列 | メーターID。 |
startDate | 文字列 | 日付範囲の開始日。 |
endDate | 文字列 | 日付範囲の終了日。 |
callbackUrl | String | サービスがジョブステータスを送信するために使用するURL。 |
createTime | String | エクスポートジョブが作成された時刻。 |
updateTime | String | エクスポートジョブが最後に更新された時刻。 |
POST応答の例
成功した場合、次の例のような応答を受信します。
{
"jobId": "cYjwJNEF7OckWEmkSC1tSI",
"status": "CREATED",
"orgId": "4wMFqGlxAKVlIFTixlTSOY",
"userId": "aMxRLnYzdWtlkJvDbtPZOr",
"selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY",
"meterId": null,
"startDate": "2024-08-12T00:00:00Z",
"endDate": "2024-09-12T00:00:00Z",
"callbackUrl": "https://MyExportJobStatus.com",
"createTime": "2024-09-12T23:21:19Z",
"updateTime": "2024-09-12T23:21:19Z"
}
アセットレベルのデータの要求
メータリングデータをアセット別にエクスポートするジョブを実行できます。
ジョブの開始後、ジョブのステータスを確認できます。詳細については、「
メータリングデータのエクスポートジョブのステータスの取得」を参照してください。
ジョブが正常に完了した後に、データをダウンロードする要求を送信できます。データファイルには、次のようなカラムが含まれています。
- •メーターID
- •メーター名
- •日付
- •アセット名
- •アセットタイプ
- •プロジェクト
- •フォルダー
- •組織ID
- •組織タイプ
- •環境名
- •環境タイプ
- •層
- •単位あたりのIPU
- •使用率
- •消費(IPU)
POST要求
エクスポートジョブ要求を送信するには、次のURIを使用します。
/public/core/v3/license/metering/ExportMeteringData
次の表に、要求に含めるフィールドを示します。
フィールド | タイプ | 必須 | 説明 |
|---|
startDate | String | ○ | ISO 8601形式の日付範囲の開始。例: 2022-08-12T00:00:00Z |
endDate | String | ○ | ISO 8601形式の日付範囲の終了。 アセットレベルのデータを要求する場合、範囲は最大30日間です。 |
meterId | 文字列 | - | メーターID。アセットレベルのデータをエクスポートする場合は、1つのメーターのデータをエクスポートできます。デフォルトでは、すべてのメーターのデータが含まれます。 |
jobType | String | ○ | エクスポートするメータリングデータのタイプ。 ASSETを使用します。 |
callbackUrl | 文字列 | - | サービスがジョブのステータスをポストする、有効かつパブリッシュされたURL。 |
POST要求の例
次の例のような要求を使用できます。
{
"startDate":"2024-08-12T00:00:00Z",
"endDate":"2024-09-12T00:00:00Z",
"meterId":"a2nB20h1o0lc7k3P9xtWS8",
"jobType":"ASSET",
"callbackUrl":"https://MyExportJobStatus.com"
}
POST応答
次の表に、応答フィールドを示します。
フィールド | タイプ | 説明 |
|---|
jobID | String | エクスポートジョブのID。 |
status | String | エクスポートジョブのステータス。 |
orgId | String | 要求元の組織の組織ID。 |
userId | String | 要求を送信したユーザーのID。 |
selectedOrgId | String | 要求元の組織の組織ID。 |
meterId | 文字列 | メーターID。 |
startDate | 文字列 | 日付範囲の開始日。 |
endDate | 文字列 | 日付範囲の終了日。 |
callbackUrl | String | サービスがジョブステータスを送信するために使用するURL。 |
createTime | String | エクスポートジョブが作成された時刻。 |
updateTime | String | エクスポートジョブが最後に更新された時刻。 |
POST応答の例
成功した場合、次の例のような応答を受信します。
{
"jobId": "cYjwJNEF7OckWEmkSC1tSI",
"status": "CREATED",
"orgId": "4wMFqGlxAKVlIFTixlTSOY",
"userId": "aMxRLnYzdWtlkJvDbtPZOr",
"selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY",
"meterId": "a2nB20h1o0lc7k3P9xtWS8",
"startDate": "2024-08-12T00:00:00Z",
"endDate": "2024-09-12T00:00:00Z",
"callbackUrl": "https://MyExportJobStatus.com",
"createTime": "2024-09-12T23:19:21Z",
"updateTime": "2024-09-12T23:19:21Z"
}
ジョブレベルのメータリングデータの要求
特定のメーターについては、ジョブを実行して、特定のサービスおよび指定された日付範囲のメーターのジョブレベルの詳細をエクスポートできます。
ジョブの開始後、ジョブのステータスを確認できます。ジョブが正常に完了した後に、データをダウンロードする要求を送信できます。詳細については、「
メータリングデータのエクスポートジョブのステータスの取得」を参照してください。
POST要求
エクスポートジョブ要求を送信するには、次のURIを使用します。
/public/core/v3/license/metering/ExportServiceJobLevelMeteringData
次の表に、要求に含めるフィールドを示します。
フィールド | タイプ | 必須 | 説明 |
|---|
startDate | 日付/時刻 | ○ | 日付範囲の開始日。 |
endDate | 日付/時刻 | ○ | 日付範囲の終了日。 範囲は最大180日です。 |
allMeters | Boolean | meterIdが空白の場合は必須です。 | すべてのメーターの使用状況情報を返すかどうかを示します。次のいずれかの値を含めます。 - - TRUE。すべてのメーターの使用状況情報を返します。
- - FALSE。meterIdフィールドで指定されたメーターの使用状況情報を返します。
デフォルトはFALSEです。 |
meterId | String | allMetersがFALSEの場合は必須です。 | |
callbackUrl | String | - | サービスがジョブのステータスをポストする、有効かつパブリッシュされたURL。 |
POST要求の例
次の例のような要求を使用できます。
POST <baseApiUrl>/public/core/v3/license/metering/ExportServiceJobLevelMeteringData
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"startDate":"2022-08-12T00:00:00Z",
"endDate":"2022-10-25T00:00:00Z",
"allMeters":"FALSE",
"meterId":"3TaYTMo6BFYeNIABfVmH0n",
"callbackUrl":"https://MyExportJobStatus.com"
}
POST応答
次の表に、応答フィールドを示します。
フィールド | タイプ | 説明 |
|---|
jobID | String | エクスポートジョブのID。 |
status | String | エクスポートジョブのステータス。 |
errorMessage | String | ジョブに関連付けられているエラーメッセージ（存在する場合）。 |
orgId | String | 要求元の組織の組織ID。 |
userId | String | 要求を送信したユーザーのID。 |
selectedOrgId | String | 要求元の組織の組織ID。 |
allMeters | Boolean | すべてのメーターの使用状況情報が含まれるかどうかを示します。 |
meterId | String | メーターID。 |
startDate | 日付/時刻 | 日付範囲の開始日。 |
endDate | 日付/時刻 | 日付範囲の終了日。 |
callbackUrl | String | サービスがジョブステータスを送信するために使用するURL。 |
createTime | String | エクスポートジョブが作成された時刻。 |
updateTime | String | エクスポートジョブが最後に更新された時刻。 |
POST応答の例
成功した場合、次の例のような応答を受信します。
{
"jobId": "cYjwJNEF7OckWEmkSC1tSI",
"status": "CREATED",
"orgId": "4wMFqGlxAKVlIFTixlTSOY",
"userId": "aMxRLnYzdWtlkJvDbtPZOr",
"selectedOrgId": "4wMFqGlxAKVlIFTixlTSOY",
"allMeters":"FALSE",
"meterId": 3TaYTMo6BFYeNIABfVmH0n,
"startDate": "2020-01-01T10:00:00Z",
"endDate": "2022-12-31T00:00:00Z",
"callbackUrl": "https://MyExportJobStatus.com",
"createTime": null,
"updateTime": null
}
エラーが発生した場合、応答は次の例のようになります。
{
"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": "3TaYTMo6BFYeNIABfVmH0n",
"userId": "aMxRLnYzdWtlkJvDbtPZOr",
"selectedOrgId": "3TaYTMo6BFYeNIABfVmH0n",
"allMeters":"FALSE",
"meterId": 3TaYTMo6BFYeNIABfVmH0n,
"startDate": "2020-01-01T10:00:00Z",
"endDate": "2022-12-31T00:00:00Z",
"callbackUrl": "https://MyExportJobStatus.com",
"createTime": null,
"updateTime": null
}
ジョブレベルレポートのメーターID
ジョブレベルのメータリングデータをエクスポートする要求を作成するときは、要求にメーターIDを含めてメーターを指定します。
次の表に、ジョブレベルのメータリングデータのエクスポートをサポートするメーターのメーターIDを示します。
メーター名 | メーターID |
|---|
詳細データ統合 | 3TaYTMo6BFYeNIABfVmH0n |
高度なサーバーレスとの詳細データ統合 | 8tXWie0ZQLWlG1cyxxLwQM |
高度なプッシュダウンの最適化 | dMN0VeTW4cThHyPovp4GEX |
アプリケーション統合 | 3uIRkIV5Rt9lBbAPzeR5Kj |
高度なサーバーレスとのアプリケーション統合 | bN6mes5n4GGciiMkuoDlCz |
PowerCenter用Cloudデータ統合 | eNYBoIrr3KDgtDN9E6lXid |
PowerCenter用Cloudデータ統合 - プッシュダウンの最適化 | 8y72urWKS85gGBRVi6tJGA |
PowerCenterのクラウドデータ統合 - 変更データキャプチャとリアルタイム | 5rtHwmyoQ6HjmJt8mqXTwc |
データ統合 | a2nB20h1o0lc7k3P9xtWS8 |
高度なサーバーレスとのデータ統合 | 35m9fB23Tykj4Fb3rN5q2J |
データ統合 - 変更データキャプチャ | 0sDTANKFZBSbqjzKaXKlmB |
データ検証 | 2qJ9COoAhfMrsH7mCyh86M |
統合ハブ | fqttkiGnSaHeXW255z4IcD |
一括取り込みアプリケーション | i3H6LcmMIYjhUKa9VCi7CI |
一括取り込みアプリケーション - 変更データキャプチャ | 4cPkZ5cZxjzc4SK2RHoqgy |
一括取り込みデータベース | 24WXkCWzeSHjFlQvLPDegF |
一括取り込みデータベース - 変更データキャプチャ | aluxJ8jOKmzdXwD0JuHRS1 |
一括取り込みファイルのMicrosoft SQL ServerおよびAzure SQL Databaseターゲット | lCwc4CfL7EEhv9773egFC8 |
一括取り込みストリーミング | hr7GsCwFFmyfvfZQFn8v81 |
モデルサーバー | 27nMlr1rtjAk5tOJ3dLoY7 |
メータリングデータのエクスポートジョブのステータスの取得
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
}
カスタムIPUアラート設定の取得
GET要求を使用して、組織またはタグに設定したカスタムIPUアラートしきい値を取得します。
GET要求
組織のカスタムIPUアラート設定を取得するには、次のURlを使用します。
/public/core/v3/metering/ipuAlert/org('<organization Id>')
タグのカスタムIPUアラート設定を取得するには、次のURlを使用します。
/public/core/v3/metering/ipuAlert/org('organization Id')/viewTagsPreference
GET応答
応答には、組織の設定の次のフィールドが含まれます。
フィールド | タイプ | 説明 |
|---|
orgName | 文字列 | 組織の名前。 |
orgId | 文字列 | 組織のID。 |
parentOrgId | 文字列 | 親組織のID。このフィールドは、サブ組織にのみ適用されます。それ以外の場合はNULLになります。 |
thresholdValue | 整数 | しきい値が設定されています。 |
ipuConsumed | BigDecimal | 使用されたIPUの数を指定します。このフィールドの値はipuThresholdPrefTypeフィールドに関連するもので、絶対値またはパーセンテージが表示されます。 |
ipuThresholdPrefType | 文字列 | しきい値のタイプ。次のいずれかの値を返します。 |
応答には、タグの設定の次のフィールドが含まれます。
フィールド | タイプ | 説明 |
|---|
orgId | 文字列 | 組織のID。 |
projectName | 文字列 | プロジェクトの名前。 |
folderName | 文字列 | フォルダの名前。プロジェクトベースのしきい値の場合、フォルダ名はNULLになります。 |
thresholdValue | 整数 | しきい値の値。 |
currentConsumption | BigDecimal | 使用されたIPUの数を指定します。このフィールドの値はipuThresholdPrefTypeフィールドに関連するもので、絶対値またはパーセンテージが表示されます。 |
ipuThresholdPrefType | 文字列 | しきい値のタイプ。次のいずれかの値を返します。 |
GET応答の例
成功した場合、組織の設定に関して次のような応答を受け取ることがあります。
{
"orgName": "Infa",
"orgId": "3nqii4jGTiLda0M3ympy4E",
"parentOrgId": null,
"thresholdValue": 35,
"ipuConsumed": 100,
"ipuThresholdPrefType": "ABSOLUTE"
}
タグの設定に対する正常な応答は、次のようになります。
{
"orgId": "3nqii4jGTiLda0M3ympy4E",
"projectName": "My Project",
"folderName": "Mapping Jobs",
"thresholdValue": 20,
"currentConsumption": 10,
"ipuThresholdPrefType": "PERCENTAGE"
}
メータリングデータのダウンロード
エクスポートジョブが正常に完了した後に、GET要求を使用して、要求されたメータリングデータを含むZIPファイルをダウンロードします。
ZIPファイルは、ジョブがSUCCESSまたはPARTIAL_SUCCESSのステータスで完了してから3日間ダウンロードできます。
注: ジョブのステータスがPARTIAL_SUCCESSの場合、ZIPファイルをダウンロードできます。ただし、ZIPファイル内のデータは完全ではない可能性があります。
GET要求
ZIPファイルをダウンロードするには、次のURIを使用します。
public/core/v3/license/metering/ExportMeteringData/<jobId>/download
GET応答
正常に完了すると、応答タイプapplication/zipのZIPストリームを応答本文で受け取ります。ファイルをダウンロードするには、Postmanを使用して、次の図に示すように応答をファイルに保存します。
