メインコンテンツまでスキップ

日次使用量を照会 (V2)

指定した期間における、指定した組織の日次使用量を照会します。現在のユーザーは組織オーナーまたは請求管理者である必要があります。

POST/v2/usage/query
接続エンドポイント

https://api.cloud.zilliz.com

NaN
shell
export BASE_URL="https://api.cloud.zilliz.com"
パラメータ
Authorizationstringheader必要

認証トークンは、適切な権限を持つ API key である必要があります。

値の例： Bearer {{TOKEN}}
リクエスト・ボディapplication/json
startstring<date-time>

照会期間の開始時刻です。RFC 3339 形式（例: 2026-09-16T00:00:00Z）で指定します。UTC の 0 時ちょうどである必要があります。UTC 以外のオフセットは先に UTC へ変換され、日付がずれます。開始時刻が UTC 0 時でない場合、エラーにはならず、その日の items が空で total が 0 の区間が返されます。

endstring<date-time>

照会期間の終了時刻です。RFC 3339 形式（例: 2026-09-17T00:00:00Z）で指定します。終了日は境界に含まれます。end を start と同じ値にすると、1 日分の区間のみ返されます。

bash
export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/usage/query" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "start": "2024-01-01T00:00:00Z",
    "end": "2024-02-01T00:00:00Z"
}'
レスポンス200 OK - application/json

指定した期間における、指定した組織の日次使用量の詳細を返します。

指定した期間における組織の日次使用量の詳細を返します。

codeinteger

レスポンスコード。

dataobject

使用量照会の結果です。照会した全期間が 1 回のレスポンスで返されます。

resultsarray
[]resultsobject
intervalStartstring<date-time>

照会する期間の開始時刻です。形式は YYYY-MM-DDTHH:mm:ssZ です。

intervalEndstring<date-time>

照会する期間の終了時刻です。形式は YYYY-MM-DDTHH:mm:ssZ です。

totalnumber

指定した期間内の使用量の合計金額です。

currencystring

合計金額に適用される通貨です。

itemsarray

指定した期間内の使用量の内訳です。

[]itemsobject
costTypestring

コストの種類です。

propertiesobject

現在のコスト項目の詳細です。

projectIdstring

このコスト項目を生成するクラスターが属するプロジェクトの ID です。

regionIdstring

このコスト項目を生成するクラスターが属するリージョンの ID です。

cuTypestring

このコスト項目を生成するクラスターの compute unit (CU) の種類です。

planstring

このコスト項目を生成するクラスターのサブスクリプションプランです。

clusterIdstring

このコスト項目を生成するクラスターの ID です。

resourceTypestring

課金対象リソースの種類です。

resourceIdstring

課金対象リソースの ID です。

volumeNamestring

ボリュームの名前です。

requestClassstring

課金対象リクエストのクラスです。

quantitynumber

コスト項目に対応する使用済みリソースの量です。

unitstring

コスト項目に対応する使用済みリソース量の単位です。

listPriceobject

コスト項目に対応する使用済みリソースの定価です。

unitPricenumber

使用済みリソースの単価です。

priceobject

コスト項目に対応する使用済みリソースの実際の価格です。

unitPricenumber

使用済みリソースの単価です。

amountnumber

このコスト項目の金額です。通貨は当該区間の currency に従います。

エラーメッセージを返します。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Ctrl I