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

クラスタメトリクスの照会 (V2)

特定のクラスタのメトリクスを照会します。

POST/v2/clusters/{CLUSTER_ID}/metrics/query
接続エンドポイント

https://api.cloud.zilliz.com

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

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

値の例： Bearer {{TOKEN}}
CLUSTER_IDstringpath必要

対象クラスタの ID。

値の例： inxx-xxxxxxxxxxxxxxx
リクエスト・ボディapplication/json
startstring

メトリクスレポート期間の開始日時。UTC の ISO 8601 タイムスタンプ形式で指定します。period パラメータが設定されていない場合は、このパラメータと end を含めてください。

endstring

メトリクスレポート期間の終了日時。UTC の ISO 8601 タイムスタンプ形式で指定します。period パラメータが設定されていない場合は、このパラメータと start を含めてください。

periodstring

Zilliz Cloud がメトリクスをレポートする期間。UTC の ISO 8601 duration 形式で指定します。start と end の両方のパラメータが設定されていない場合は、このパラメータを含めてください。

granularitystring必要

Zilliz Cloud がメトリクスをレポートする時間間隔。UTC の ISO 8601 duration 形式で指定します。最小の粒度は PT30S です。

dbNamestring

対象データベースの名前。

collectionNamestring

対象コレクションの名前。

metricQueriesarray必要

MetricQuery オブジェクトのリスト。

[]metricQueriesobject必要

MetricQuery オブジェクト。

namestring必要

メトリクスの名前。
指定可能な値については、列挙値を参照してください。
これらのメトリクスの詳細については、Metrics & Alerts Reference を参照してください。

bash
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}/metrics/query" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "start": "2024-06-30T16:09:53Z",
    "end": "2024-07-01T16:09:53Z",
    "granularity": "PT6H",
    "metricQueries": [
        {
            "name": "CU_COMPUTATION"
        }
    ]
}'
レスポンス200 OK - application/json

指定したメトリクスについて収集された統計情報の詳細を返します。

codeinteger

レスポンスコード。

dataobject

レスポンスペイロード。

resultsarray

指定したメトリクスについて収集された統計情報のリスト。

[]resultsobject

収集された統計情報のセット。

namestring

メトリクス名。

unitstring

統計情報内の値の単位。

valuesarray

各間隔で収集された統計情報のリスト。

[]valuesobject

ある間隔期間内に収集された統計情報。

timestampstring

ISO 8601 形式のデータポイントのタイムスタンプ。

valuestring

The value of the metric at the given timestamp.

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "results": [
            {
                "name": "CU_COMPUTATION",
                "unit": "percent",
                "values": [
                    {
                        "timestamp": "2024-06-30T16:09:53Z",
                        "value": null
                    },
                    {
                        "timestamp": "2024-06-30T22:09:53Z",
                        "value": "1.00"
                    },
                    {
                        "timestamp": "2024-07-01T04:09:53Z",
                        "value": "1.00"
                    },
                    {
                        "timestamp": "2024-07-01T10:09:53Z",
                        "value": "1.00"
                    }
                ]
            }
        ]
    }
}
Ctrl I