ガイドAPIリファレンス
ガイド

リクエストのトラッキング - HERE Raster Tile API

APIリクエストにX-Request-IDbillingTagを含めて、システム管理者と開発者がリクエスト処理の効率を分析、改善、向上できるようにします。

X-Request-ID

この一意の識別子を使用すると、実施するリクエストをサーバーのログ エントリーにリンクできます。この ID を作成して、リクエストと一緒にサーバーに送信できます。受信すると、サーバーはすべてのログ エントリーにこの ID を埋め込みます。

リクエストの問題をトラブルシューティングする際にこの ID をバグ レポートに含めることで、リクエストに関連する正確なログ ステートメントの追跡が円滑になります。これによりタイムスタンプ、IP などの要因に依存する必要がなくなり、デバッグ プロセスが合理化されます。

ベスト プラクティスとして、セキュリティ、整合性、一般的な慣行の順守を強化するために、リクエスト ヘッダーに X-Request-ID を埋め込みます。次のサンプルはPythonでX-Request-IDを自動的に生成してリクエストヘッダーに追加する方法を示しています。

import requests
import uuid

# Generate a unique X-Request-ID using uuid
x_request_id = str(uuid.uuid4())

# Define the headers
headers = {
    'X-Request-ID': x_request_id,
    # Add other headers as needed
}

# Make the request
response = requests.get('http://example.com', headers=headers)
📘

  • X-Request-ID ヘッダーが正しく記録され返されるのは、キャッシュ ミスの原因となるリクエスト (CDN (コンテンツ配信ネットワーク) がリクエストを処理するために送信元サーバーからコンテンツを取得する必要があるユースケース) の場合だけです。
  • キャッシュヒットにつながるリクエスト(すでにキャッシュに保存されており、送信元サーバーから取得する必要がないコンテンツをリクエストするユースケース)の場合、ユーザーが提供するX-Request-IDがサーバー側で自動生成された別のX-Request-IDに置き換えられます。

billingTag

これは請求レポートでコストをグループ化および分類するためにリクエストに追加できる、ユーザー定義のキーと値のペアです。billingTag を使用することでリクエストの使用状況を追跡してさまざまなチーム、プロジェクト、環境全体でコストを管理できます。X-Request-ID はたいてい自動的に生成されてリクエストのトレースに使用されますが、請求タグは通常、手動で設定されます。

有効な請求タグの作成方法の詳細については、コスト管理の開発者ガイドの「請求タグを追加して使用する」を参照してください。

たとえば、クライアント アプリケーションがルーティング リクエストとレンダリング リクエストの両方に関与するタスクを開始する場合、すべての操作に対して同じ billingTag 値を使用できます。この共有識別子は後ほど、サービスに送信されたリクエストの数に関係なく、タスクの全体的な価格計算などの請求目的で相互接続されたリクエストを分類および統合するのに役立ちます。