すべての使用量レポートリクエストのステータス取得方法

このチュートリアルでは、すべてのレポートの使用量レポートステータスの取得方法を説明します。

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

APIレスポンスレコードは作成日に基づいて昇順または降順で表示されます。リクエストに並べ替えを追加するにはsortパラメーターを使用します。sortパラメーターをリクエストで使用しない場合、デフォルトではレコードは降順で表示されます。

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

GET https://usage.bam.api.here.com/v2/usage/realms/org123456789/reports

パラメーター

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

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


realmId 必須	文字列[ 5 ...30 ]文字。 _例：_org123456789 パートナー組織ID。
limit	整数[ 1 ...100 ]。デフォルト：100 返されるレコードの数。デフォルトは最大レコード数である100件に設定されています。
sort	string デフォルト："desc" 列挙型 (enum)："asc"、"desc" 各レポートのステータスは作成日に基づき昇順または降順で返されます。
offset	0以上の整数。デフォルト：0 ページ番号をオフセットします。

ヘッダーパラメーター


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

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

{
    "total": 18,
    "limit": 5,
    "count": 2,
    "nextOffset": 0,
    "lastOffset": 3,
    "items": 
[
{
    "id": "REPORT-100",
    "status": "inProgress",
    "created": "2022-03-01'T'00:00:00",
    "parameters": 
    {
        "realm": "org1879256",
        "startDate": "2022-03-01'T'00:00:00",
        "endDate": "2022-07-01'T'00:00:00",
        "emailId": "[email protected]"
    }
},
{
    "id": "REPORT-145",
    "status": "completed",
    "resultHref": "https://usage/realms/org236848/report/REPORT-1475/output",
    "created": "2022-04-01'T'00:00:00",
    "parameters": 
    {
        "realm": "org1879256",
        "startDate": "2022-03-01'T'00:00:00",
        "endDate": "2022-07-01'T'00:00:00",
        "emailId": "[email protected]"
    }
},
{
    "id": "REPORT-167",
    "status": "failed",
    "created": "2022-08-01'T'00:00:00",
    "parameters": 
            {
                "realm": "org1879586",
                "startDate": "2022-03-01'T'00:00:00",
                "endDate": "2022-07-01'T'00:00:00",
                "emailId": "[email protected]"
            }
        }
    ]
}