ウェアハウスの CCU 使用状況をクエリする
最大 31 日間の期間について、PhoenixAI クラスター内の各ウェアハウスの CCU 使用状況をクエリします。クラスターの総 CCU 使用量(クラスターの CCU 使用状況をクエリする を参照)をウェアハウスごとに分けて確認する場合に使用します。
注意
この操作には、請求の表示および管理の権限が必要です。
リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://cloud-api.celerdata.com/api/1.0/usages/:cluster_id/warehouses |
| HTTP メソッド | GET |
| 頻度 | 600/分 |
パス変数
| パラメーター | 例 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| cluster_id | 4ae48a3f-f840-46fa-b0e7-0709a220fa40 | はい | String | クラスターの ID。 PhoenixAI Cloud コンソール にサインインし、クラスターの 概要 ページの クラスター プロパティ セクションに移動してクラスター ID を取得できます。 |
:<variable_name> は、Postman などの Web 開発ツールでの URL パス変数を示します。上記の URL パスの :cluster_id は、クエリしたいクラスターの ID を示します。ただし、curl などの他のツールを使用する場合は、curl コマンド内で :cluster_id を実際のクラスター ID に手動で置き換える必要があります。
ヘッダー パラメーター
| パラメーター | 例 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| Authorization | Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY | はい | String | PhoenixAI Cloud API にアクセスするためのアクセストークン。形式: Bearer <access_token>。 |
アクセストークンの取得 を参照してください。
クエリ パラメーター
| パラメーター | 例 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| start_date | 20230701 | はい | String | クエリする期間の開始日(この日を含む)。形式: yyyyMMdd。 |
| end_date | 20230731 | はい | String | クエリする期間の終了日(この日を含む)。形式: yyyyMMdd。end_date は start_date 以上でなければならず、期間は最大 31 日間です。 |
| warehouse_ids | wh-1a2b3c,wh-4d5e6f | いいえ | String | クエリするウェアハウスの ID のカンマ区切りリスト。このパラメーターを指定しない場合、期間内に CCU 使用量があるクラスターのすべてのウェアハウスが返されます。これには、その後リリースされたウェアハウスも含まれます。 |
| show_detail | true | いいえ | Boolean | CCU 使用状況の詳細を日ごとに返すかどうか。デフォルト値: false。 |
日付は UTC として解釈されます。
サンプルリクエスト
curl -X GET \
'https://cloud-api.celerdata.com/api/1.0/usages/82964bc5-a8ce-4236-9fe6-1ad1e0f80e15/warehouses?start_date=20230701&end_date=20230731&show_detail=true' \
-H 'Authorization: Bearer <access_token>'
レスポンス
サンプルレスポンス
{
"code":20000,
"data":[
{
"warehouse_id":"wh-1a2b3c",
"warehouse_name":"default_warehouse",
"total_usage":"87.025277",
"details":[
{
"usage":"18.130654",
"date":20230703,
"time_stamp":1688342400
}
]
}
]
}
show_detail が false に設定されている場合、または指定されていない場合、data 配列の各オブジェクトには "details": null が含まれます。
レスポンス要素
| パラメーター | 例 | 型 | 説明 |
|---|---|---|---|
| code | 20000 | Integer | エラーコード。エラーコードが 20000 の場合、リクエストは成功しました。それ以外のエラーコードが返された場合、リクエストは失敗しました。 |
| data | - | Array | API 呼び出しの結果。data は、選択された期間に CCU 使用量があるウェアハウスごとに 1 つのオブジェクトで構成される配列です。CCU 使用量のないウェアハウスは返されず、CCU 使用量のあるウェアハウスがない場合、配列は空になります。オブジェクトの順序は保証されません。各オブジェクトは、以下の要素で構成されています:
|
| data.0.warehouse_id | wh-1a2b3c | String | ウェアハウスの ID。 |
| data.0.warehouse_name | default_warehouse | String | ウェアハウスの名前。 |
| data.0.total_usage | 87.025277 | String | 選択された期間におけるウェアハウスの総 CCU 使用量。 |
| data.0.details | - | Array | ウェアハウスの日別の CCU 使用状況の詳細。details は、CCU 使用量がある日付ごとに 1 つのオブジェクトで構成される配列です。details 配列は、リクエストの show_detail パラメーターが true に設定されている場合にのみ返されます。それ以外の場合、details は null です。 |
| data.0.details.0 | - | Object | 特定の日付におけるウェアハウスの CCU 使用状況の詳細。各オブジェクトは、以下の要素で構成されています:
|
| data.0.details.0.usage | 18.130654 | String | 特定の日付の CCU 使用量。 |
| data.0.details.0.date | 20230703 | Integer | 特定の日付。形式: yyyyMMdd(UTC)。 |
| data.0.details.0.time_stamp | 1688342400 | Integer | 特定の日付の開始時刻を表す Unix タイムスタンプ(秒、UTC)。 |
| message | param start_date is invalid | String | エラーメッセージ。この要素は、返された code が 20000 でない場合にのみ返されます。注意 リクエストが成功したか失敗したかを message の返り値に基づいて判断しないでください。 |
エラーコード
| code | message | 原因 |
|---|---|---|
| 30000 | param start_date is invalid | start_date が指定されていないか、yyyyMMdd 形式ではありません。 |
| 30000 | param end_date is invalid | end_date が指定されていないか、yyyyMMdd 形式ではありません。 |
| 30000 | param end_date should greeter than or equal to start_date | end_date が start_date より前の日付です。 |
| 30000 | the time range is out of limits.max:31 days | 期間が 31 日間を超えています。 |
| 40004 | cluster not exists | クラスターが存在しないか、お使いのアカウントに属していません。 |
| 50005 | - | 内部サーバーエラー。しばらくしてから再試行してください。 |