ログインアカウントの CCU 使用量をクエリする

ログインアカウントの CCU 使用量をクエリします。

リクエスト

基本情報
HTTP URL	https://cloud-api.celerdata.com/api/1.0/usages
HTTP メソッド	GET
頻度	600/分

ヘッダーパラメータ

パラメータ	例	必須	タイプ	説明
Authorization	Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY	はい	String	CelerData Cloud BYOC API にアクセスするためのアクセストークン。形式: Bearer <access_token>。

アクセストークンの取得 を参照してください。

クエリパラメータ

パラメータ	例	必須	タイプ	説明
start_date	20230701	はい	String	クエリする期間の開始日。形式: yyyyMMdd。
end_date	20230731	はい	String	クエリする期間の終了日。形式: yyyyMMdd。 start_date は end_date 以下でなければならず、start_date から end_date を引いた結果は 0 から 31 の範囲でなければなりません。
show_detail	true	いいえ	Boolean	日ごとの CCU 使用量の詳細を返すかどうか。

レスポンス

サンプルレスポンス

{
    "code":20000,
    "data":{
        "account_id":"lbyx0bt7a",
        "total_usage":"1534.833393",
        "details":[
            {
                "usage":"48.000000",
                "date":20230701
            }
        ]
    }
}

レスポンス要素

パラメータ	例	タイプ	説明
code	20000	Integer	エラーコード。20000 が返された場合、リクエストは成功しました。他のエラーコードが返された場合、リクエストは失敗しました。
data	-	Object	API 呼び出しの結果。いくつかの API アクションでは data オブジェクトが返されない場合があります。以下の要素で構成されています: account_id usage details
data.account_id	lbyx0bt7a	String	クエリされたアカウントの ID。
data.total_usage	1534.833393	String	選択した期間におけるアカウントの総 CCU 使用量。
data.details	-	Array	選択した期間におけるアカウントの CCU 使用量の詳細。details は、選択した期間の日数に応じて、特定の日付の CCU 使用量の詳細を含む 1 つ以上のオブジェクトで構成される配列です。 details 配列は、リクエストの show_detail パラメータが true に設定されている場合にのみ返されます。
data.details.0	-	Object	各特定の日付におけるアカウントの CCU 使用量の詳細。各オブジェクトは以下の要素で構成されています: usage date
data.details.0.usage	48.000000	String	特定の日付の使用量。
data.details.0.date	20230701	Integer	特定の日付。
message	The time range is out of limits.max:31 days	String	エラーメッセージ。この要素は、返された code が 20000 でない場合にのみ返されます。 注意 リクエストが成功したか失敗したかを message の返り値に基づいて判断しないでください。