パートナーが使用状況レポートリクエストを生成します

パートナーは、組織またはサブアカウントの使用状況レポートリクエストを生成できます。 サブアカウントが渡されない場合は、パートナー組織の使用状況レポートのみが生成されます。 サブアカウントがリクエスト本文に渡された場合、使用状況レポートはサブアカウントのデータで構成されます。

クエリパラメータを使用して、アプリ ID 、プロジェクト HERE リソースネーム 、または請求タグでクエリを実行することで、追加のフィルタを追加できます。 フィルタが追加されると、応答にはフィルタ条件に一致するエレメントが含まれます。 groupBy 応答に含まれるプロパティのグループ化を制御する機能があります。 既定 ではgroupBy、appId、name、およびbillingTagがあります。つまり、これらのすべてのプロパティが応答に含まれます。

レポート生成リクエストでは、要約、日、および月の詳細レベルがサポートされます。デフォルトのレベルは要約に設定されています（時間レベルはサポートされていません）。 使用状況レポート csv ファイルで返されるレコードの最大数は 100 万で、クエリーできる最大時間範囲は 95 日です。

API 応答には、リクエストの現在のステータスが含まれ、「レポートステータスを取得」リクエストの URL が含まれているヘッダーもあります。

リクエスト

この例では 、に org123456789 を使用realmIdしています。

POST /usage/realms/org123456789/reports

本文を要求します

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

パラメーター

このリクエストには、表示されている HERE パラメータが必要です。 すべてのパラメータの一覧について は、チュートリアルの概要を参照してください。

使用状況の検索結果はページにグループ化されます。 ページとは、 1 つのビューに表示される使用状況レコードのセットです。 検索結果のビューは、オフセットおよび境界パラメーターを使用してカスタマイズできます。 オフセットによってビューの現在のページ番号が決定され、検索結果の数が指定した数に制限されます。

realmId が必要です 文字列 [5..] 30] 文字
の例 : org123456789
自分の組織 ID 。
開始日
が必要です 		文字列
の例 : startDate=yyyy-mm-dd'T'HH:mm:ss
検索の開始日。
終了日
が必要です 		文字列
の例 : endDate=yyyy-mm-dd 'T'H:mm:ss>
検索の終了日。
featureID 256 文字以下の文字列
。例
: featureId=hrn: here::service::org123456789: search-geocoding-1 Feature HERE リソースネーム 。
AppID 128 文字以下の文字列
。例
: appId = j1dasda012edasfgne クライアント アプリケーション ID 。これは、プラットフォーム で作成されたアプリケーション ID です。
チャネル ID 文字列
列挙型 (enum) : "hot" "cold"
の例 : channelId = cold
このパラメータを指定すると、結果は、使用状況のレポートに使用されたチャネルを識別する ID でフィルタリングされます。 コールドチャネルは新しい請求データ処理パイプラインですが、ホットチャネルは古い請求データ処理パイプラインです。 ChannelId はテスト目的で使用されます。
projectHrn 256 文字以下の文字列
例 : projectHrn=hrn: here::authorization::myrealm: project/my-project-0000
プロジェクトを識別する HERE リソースネーム 。
billingTag 500 文字以下の文字列
。例
: billingTag=testtag 請求タグは、請求書のコストを結合するために使用されます。
カテゴリ 128 文字以下の文字列
。例
: category= パイプラインカテゴリは、選択したサービスの名前 ( 位置情報サービスやパイプラインなど ) で、請求されます。
詳細レベル 文字列
列挙型 (enum) : "summarized" "hour" " "day" "month"
の例 : detailLevel= 時間
このクエリ パラメーターを使用して、使用状況レコードに表示する詳細レベルのいずれかを選択できます。 詳細レベルには、要約、時間、日、または月が含まれます。 要約された詳細レベルには、使用状況の概要が表示されます。これがデフォルトです。 detailLevel が SUMMARTED に設定されている場合、 usageDateTime フィールドの値は表示されません。
グループ化 256 文字以下の文字列
。例 : groupBy=appId, billingTag, project, resource
groupBy パラメータは、グループとして結合されるパラメータのコンマ区切りのリストです。 サポートされている値は、 project 、 billingTag 、および appId です。 デフォルトの groupBy パラメータは、 featureId およびサブスクリプション ID です。groupBy パラメータがクエリに追加されると、 featureId およびサブスクリプション ID に追加されます。
usageFields 文字列の配列
列挙型 (enum) ："realmId" "featureId" "billingSubscriptionId" "billingChargeNumber" " カテゴリ " " 名前 " valueDriver" usageValue" " リソース
" 例 : usageFields=realmId, featureId, category
応答のフィルタリングに使用される一意 / 個別の使用フィールド名のセット。

ヘッダーパラメーター

X-Request-ID ユーザー
が指定した文字列のトークン 。サービスに送信されたリクエストまたはリクエストのグループを追跡するために使用できます。
X-Correlation-ID
が必要です 		自動
生成された文字列の ID 。応答で使用可能なリクエストを一意に識別します。 特定のリクエストについて問い合わせがある場合にサポートに連絡するときは、このヘッダの値を入力してください。この値は、問題のトラブルシューティングに役立ちます。

リクエスト本文

サブアカウント
が必要です 		オブジェクト
各サブアカウントの組織 ID 。

HTTP 201 に応答します

{

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

}

詳細については 、 Usage API リファレンスを参照してください。

「」に一致する結果は 件です

    「」に一致する結果はありません