ガイドAPIリファレンス
ガイド
  1. コスト管理開発ガイド
  2. コスト管理チュートリアル
  3. コスト管理の使用量サービス

組織による使用量の取得方法

このチュートリアルでは、組織の使用量を取得する方法を説明します。クエリパラメーターにさらにフィルターを追加すると、アプリID、プロジェクトHRN、請求タグでクエリを実行できます。フィルターを追加すると、レスポンスにフィルター条件に一致する要素が含まれます。

groupBy機能では、位置情報サービス、コンテンツ、SDK、パイプライン、データなどのcategoryを選択して、レスポンス内の使用量データをグループ化できます。デフォルトでは、groupBy appId、name、billingTagに設定されており、レスポンスにはこれらすべてのプロパティが含まれます。

請求可能な使用量は時間単位で算出されます。APIは概要、時間、日、月の詳細レベルに対応しており、デフォルトのレベルは概要に設定されています。ユーザーは使用量をリクエストしている組織に属している必要があります。クエリできる時間範囲は最大95日間です。

APIのレスポンスレコードは、サブスクリプションID、カテゴリー、請求項目 (同じサービス内のフィーチャーを区別し、対応する請求にリンクする) ごとにアルファベットの昇順で表示されます。

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

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

パラメーター

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

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
検索する期間の終了日。
featureId256文字以下の文字列。
*例：*featureId=hrn:here:service::org123456789:search-geocoding-1
フィーチャーHRN。
appId128文字以下の文字列
*例：*appId=j1dasda012edasfgne
クライアントアプリID。これはプラットフォームが作成したアプリIDです。
channelIdstring
列挙型 (enum)："hot"、"cold"
*例：*channelId=cold
このパラメーターを設定している場合、結果は使用量レポートに使用されるチャネルを識別するIDごとにフィルターされます。コールドチャネルは新しい請求データ処理パイプラインで、ホットチャネルは古い請求データ処理パイプラインです。channelIdはテスト目的で使用します。
projectHrn256文字以下の文字列。
*例：*projectHrn=hrn:here:authorization::myrealm:project/my-project-0000
プロジェクトを識別するHRN。
billingTag500文字以下の文字列。
*例：*billingTag=testtag
請求タグを使用して、請求書のコストを合算します。
category128文字以下の文字列。
*例：*category=Pipelines
カテゴリーとは選択した請求可能なサービスの名前で、位置情報サービス、コンテンツ、SDK、データ、パイプラインなどです。
limit整数[ 1 ...100 ]。
デフォルト：100
返されるレコードの数。デフォルトは最大レコード数である100件に設定されています。
offset0以上の整数。
デフォルト：0
オフセットで検索結果ビューの現在のページ番号を指定します。
detailLevelstring
列挙型 (enum)："summarized"、"hour"、"day"、"month"
*例：*detailLevel=hour
このクエリパラメーターを使用して、使用量レコードで表示する詳細レベルを1つ選択できます。詳細レベルには、概要、時間、日、月があります。概要詳細レベルでは使用量の概要が表示され、こちらがデフォルトとなります。概要がdetailLevel値の場合、usageDateTimeフィールドの値は表示されません。
groupBy256文字以下の文字列。
*例：*groupBy=appId, billingTag, project, resource
groupByパラメーターはグループとして結合されるパラメーターのカンマ区切りのリストです。サポートされている値は、project、billingTag、appId、featureId、subscription IDです。デフォルトのgroupByパラメーターはfeatureIdとsubscription IDです。クエリにgroupByパラメーターを追加すると、featureIdとsubscription IDに追加されます。
usageFields文字列の配列
列挙型 (enum)：
realmId：組織ID。
featureId：フィーチャーHRN。
billingSubscriptionId：組織のサブスクリプションID。
billingChargeNumber：対応するサービス使用コストにマッピングする一意の請求ID。この数値を対応する使用量と組み合わせて、請求可能なコストを計算します。
category：パイプライン、データ、コンテンツ、SDK、位置情報サービスなどの製品カテゴリー。
name：組織の名前。
valueDriver：使用量の単位。GBやトランザクションなど。
usageValue：特定のサービスでのお客様の使用量を測定する数値メトリクス。
billableValue：発生した請求可能な使用量。
resource：取得されユーザーに提示されたすべての使用量のデータ統計。
*例：*usageFields=realmId,featureId,category
レスポンスのフィルターに使用される一意または固有の使用量フィールド名のセット。
*例：*usageFields=realmId,featureId,category
レスポンスのフィルターに使用される一意または固有の使用量フィールド名のセット

ヘッダーパラメーター

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

レスポンス：HTTP 200 OK

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

{
    "total": 10,
    "limit": 2,
    "items":[
    {
      "realmId": "org123456789",
      "featureId": "hrn:here:service::org123456789:search-geocoding-1",
      "billingSubscriptionId": "A-S00000021",
      "billingChargeNumber": "C-00011212",
      "category": "service",
      "name": "Geocoder Autosuggest",
      "valueDriver": "Transactions",
      "usageValue": "10",
      "billableValue": "10"
    },
    {
      "realmId": "org123456789",
      "featureId": "hrn:here:service::org123456789:search-geocoding-1",
      "billingSubscriptionId": "A-S00000021",
      "billingChargeNumber": "C-0001124",
      "category": "service",
      "name": "Lane attributes",
      "valueDriver": "GB",
      "usageValue": "10",
      "billableValue": "10"
    }
  ], 
    "nextOffset": 1,
    "lastOffset": 4
}

22 日前の更新