パートナーサブアカウントの使用量レポート作成方法

このチュートリアルでは、パートナーサブアカウントの使用量レポートを作成する方法を説明します。

パートナーは組織とサブアカウントの使用量レポートリクエストを作成できます。サブアカウントがリクエストボディに渡されない場合は、パートナー組織の使用量レポートのみが生成されます。サブアカウントがリクエストボディに渡される場合、使用量レポートにはサブアカウントが含まれます。

クエリパラメーターを使用してフィルターを追加し、アプリID、プロジェクトHRN、請求タグでクエリを実行できます。フィルターを追加すると、レスポンスにフィルター条件に一致する要素が含まれます。groupBy機能では、レスポンス内のプロパティのグループ化をコントロールできます。デフォルトでは、groupBy appId、name、billingTagがレスポンスに含まれます。

レポート生成リクエストでは、概要、日、月のレベルでの詳細に対応しており、デフォルトのレベルは概要に設定されています。使用量レポートのcsvファイルで返されるレコード数の上限は100万件で、クエリできる最大時間範囲は95日間です。

レスポンスにはリクエストの現在のステータスとレポートIDが含まれます。

このサンプルリクエストでは、realmIdに_org123456789_、startDateに_2021-07-01T10:39:51_、endDateに_2021-08-30T10:39:51_を使用しています。

POST https://usage.bam.api.here.com/v2/usage/realms/org123456789/startDate=2021-07-01T10:39:51&endDate=2021-08-30T10:39:51/reports

パラメーター

ここに示されているパラメーターは、このサンプルリクエストに必要なパラメーターのみです。パラメーターの全リストは、コスト管理の使用量API v2 APIリファレンスを参照してください。

利用状況の検索結果はページごとにグループ化できます。ページとは単一のビューに表示される使用量レコードのセットです。offsetパラメーターとlimitパラメーターを使用して、検索結果ビューをカスタマイズできます。offsetはビューの現在のページ番号を指定し、limitは検索結果を指定した数に制限します。


realmId required	文字列[ 5 ...30 ]文字。 _例：_org123456789 組織ID。
startDate 必須	文字列"date-time"。例：startDate=yyyy-MM-dd'T'HH:mm:ss 検索する期間の開始日。
endDate 必須	文字列"date-time"。例：endDate=yyyy-MM-dd'T'HH:mm:ss >検索する期間の終了日。
featureId	256文字以下の文字列。例：featureId=hrn:here:service::org123456789:search-geocoding-1 フィーチャーHRN。
appId	128文字以下の文字列。例：appId=j1dasda012edasfgne クライアントアプリID。これはプラットフォームが作成したアプリIDです。
channelId	string 列挙型 (enum)："hot"、"cold" 例：channelId=cold このパラメーターを設定している場合、結果は使用量レポートに使用されるチャネルを識別するIDでフィルターされます。コールドチャネルは新しい請求データ処理パイプラインで、ホットチャネルは古い請求データ処理パイプラインです。channelIdはテスト目的で使用します。
projectHrn	256文字以下の文字列。例：projectHrn=hrn:here:authorization::myrealm:project/my-project-0000 プロジェクトを識別するHRN。
billingTag	500文字以下の文字列。例：billingTag=testtag 請求タグを使用して、請求書のコストを合算します。
category	128文字以下の文字列。例：category=Pipelines カテゴリーとは選択した請求可能なサービスの名前で、位置情報サービス、パイプラインなどがあります。
detailLevel	string 列挙型 (enum)："summarized"、"hour"、"day"、"month" 例：detailLevel=hour このクエリパラメーターを使用して、使用量レコードで表示する詳細レベルを1つ選択できます。詳細レベルには、概要、時間、日、月があります。概要詳細レベルでは使用量の概要が表示され、こちらがデフォルトとなります。概要がdetailLevel値の場合、usageDateTimeフィールドの値は表示されません。
groupBy	256文字以下の文字列。例：groupBy=appId, billingTag, project, resource groupByパラメーターはグループとして結合されるパラメーターのカンマ区切りのリストです。サポートされている値はproject、billingTag、appIdです。デフォルトのgroupByパラメーターはfeatureIdとsubscription IDです。クエリにgroupByパラメーターを追加すると、featureIdとsubscription IDに追加されます。
usageFields	文字列の配列列挙型 (enum)："realmId"、"featureId"、"billingSubscriptionId"、"billingChargeNumber"、"category"、"name"、"valueDriver"、"usageValue"、"billableValue"、"resource" 例：usageFields=realmId,featureId,category レスポンスをフィルターする一意/distinctの使用量フィールド名のセット。

ヘッダーパラメーター


X-Request-ID	string サービスに送信された単一のリクエストまたは一連のリクエストを追跡するユーザー提供のトークン。
X-Correlation-ID 必須	string 自動生成されるID。リクエストを一意に識別し、レスポンスで利用可能。サポートチームに特定のリクエストの問い合わせを行う場合は、このヘッダーの値を共有します。こちらは問題のトラブルシューティングで役に立ちます。

リクエストボディ

以下に、要件であるリクエストボディの例を示します。


subAccounts 必須	オブジェクト各サブアカウントの組織ID。

{
    "subAccounts": 
    [
        "org112135",
        "org124566",
        "org134564"
    ]
}

レスポンス (HTTP 201) リクエストは次のサンプルレスポンスを返します。

{

    "id": "REPORT-1007",
    "status": "inProgress"

}