ガイドAPIリファレンス
ガイド
  1. コスト管理開発ガイド
  2. HEREパートナーのエンドカスタマー管理

IDによる使用量レポートリクエストのステータス取得方法

レポート作成非同期APIは特定の使用量レポートのリクエストステータスを取得し、レスポンスに含めて返します。ステータスレポートが完了すると、レスポンスから送信されるメール通知のダウンロードURLを使用してダウンロードできます。

このサンプルリクエストでは、realmIdに_org123456789_、reportIdに_REPORT-1001_を使用しています。

GET https://usage.bam.api.here.com/usage/realms/org123456789/reports/REPORT-1001/output

パラメーター

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

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

realmId
必須		文字列[ 5 ...30 ]文字。
例：org123456789
組織ID。
reportId
必須		文字列[11 ...30 ]文字。
_例：_REPORT-1001
表示するレポートのID。

ヘッダーパラメーター

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

レスポンス (HTTP 200)

リクエストは次のサンプルレスポンスのとおり、レポートのリクエストステータスを含む単一のレコードを返します。

{

    "id": "REPORT-1001",
    "status": "inProgress",
    "created": "2022-03-01'T'00:00:00",
    "parameters": 

    {
        "realm": "org123456789",
        "startDate": "2022-03-01",
        "endDate": "2022-07-01",
        "emailId": "[email protected]"
    }

}

21 日前の更新