サービス定義の使用実績をAPIで報告する

ここでは、サービス利用者が使用した使用量(サービス定義の使用実績)を報告する方法をご説明します。


1. アクセストークンの取得

使用実績報告APIにリクエストを送信するには、事前にOAuth 2.0 認証フローを使用してアクセストークンを取得する必要があります。
APIクライアントの設定で作成した認証情報を使用し、WebAPIに使用するアクセストークンを取得します。

Client Credentialsによるアクセストークンの取得方法については、こちらのページをご覧ください。

使用量の報告を行うためのアクセストークンには、「api:service:report_usage」スコープが必要となります。


2. 使用量の報告

使用量報告APIを使用してアプリケーションで測定した使用量をCloudGearに報告します。

リクエスト

POST /v1/services/<service_id>/usage_records
プレースホルダー説明
<service_id>
使用量を報告するサービスのIDを指定します。

ヘッダーやリクエストボディの詳細につきましては、こちらをご覧ください。

ベストプラクティス

使用量報告の頻度

CloudGearの課金システムは請求サイクルの最後に報告された使用量を使用してサービス契約者に利用料を請求しますが、サービスの利用者が現在の使用量を確認できるよう、なるべく短い間隔で使用量を報告することを推奨します。
適切な報告間隔は何を使用量の指標として用いるかによって異なります。サービスの使用時間に比例して頻繁に変動するような指標(例えばデータ通信量)を使用量として用いる場合の推奨報告間隔は10分程度です。頻繁に変動しない指標(例えばサービスが独自にカウントするユーザ数)の場合の推奨報告間隔は1日~数日程度です。

非常に短い間隔(10秒以下)で使用量報告APIをコールしないでください。このような間隔でAPIをコールすると、CloudGearは Invalid Request エラーを返却することがあります。