クラスターの CCU 使用状況をクエリする
CelerData クラスターの CCU 使用状況をクエリします。
注意
この操作には、請求の表示および管理の権限が必要です。
リクエスト
基本情報 | |
---|---|
HTTP URL | https://cloud-api.celerdata.com/api/1.0/usages/:cluster_id |
HTTP メソッド | GET |
頻度 | 600/分 |
パス変数
パラメーター | 例 | 必須 | 型 | 説明 |
---|---|---|---|---|
cluster_id | 4ae48a3f-f840-46fa-b0e7-0709a220fa40 | はい | String | クラスターの ID。 CelerData Cloud BYOC コンソール にサインインし、クラスターの 概要 ページの クラスター プロパティ セクションに移動してクラスター ID を取得できます。 |
:<variable_name>
は、Postman などの Web 開発ツールでの URL パス変数を示します。上記の URL パスの :cluster_id
は、クエリしたいクラスターの ID を示します。ただし、curl などの他のツールを使用する場合は、curl
コマンド内で :cluster_id
を実際のクラスター ID に手動で置き換える必要があります。
ヘッダー パラメーター
パラメーター | 例 | 必須 | 型 | 説明 |
---|---|---|---|---|
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 から start_date を引いた結果は 0 から 31 の範囲でなければなりません。 |
show_detail | true | はい | Boolean | CCU 使用状況の詳細を日ごとに返すかどうか。 |
レスポンス
サンプルレスポンス
{
"code":20000,
"data":{
"cluster_id":"82964bc5-a8ce-4236-9fe6-1ad1e0f80e15",
"cluster_name":"test_privilege_30-wybing",
"total_usage":"87.025277",
"details":[
{
"usage":"18.130654",
"date":20230703
}
]
}
}
レスポンス要素
パラメーター | 例 | 型 | 説明 |
---|---|---|---|
code | 20000 | Integer | エラーコード。エラーコードが 20000 の場合、リクエストは成功しました。それ以外のエラーコードが返された場合、リクエストは失敗しました。 |
data | - | Object | API 呼び出しの結果。いくつかの API アクションでは data オブジェクトが返されない場合があります。以下の要素で構成されています:
|
data.cluster_id | 82964bc5-a8ce-4236-9fe6-1ad1e0f80e15 | String | クエリされたクラスターの ID。 |
data.cluster_name | test_privilege_30-tom | String | クエリされたクラスターの名前。 |
data.total_usage | 87.025277 | String | 選択された期間におけるクラスターの総 CCU 使用量。 |
data.details | - | Array | 選択された期間におけるクラスターの CCU 使用状況の詳細。details は、選択された期間の日数に応じて、特定の日付の CCU 使用状況の詳細を含む 1 つ以上のオブジェクトで構成される配列です。details 配列は、リクエストの show_detail パラメーターが true に設定されている場合にのみ返されます。 |
data.details.0 | - | Object | 各特定の日付のクラスターの CCU 使用状況の詳細は、オブジェクトとして提示されます。各オブジェクトは、以下 の要素で構成されています:
|
data.details.0.usage | 18.130654 | String | 特定の日付の使用量。 |
data.details.0.date | 20230703 | Integer | 特定の日付。 |
message | param start_date is invalid | String | エラーメッセージ。この要素は、返された code が 20000 でない場合にのみ返されます。注意 リクエストが成功したか失敗したかを message の返り値に基づいて判断しないでください。 |