Query Metrics (V1)

ノート

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

POST/v1/clusters/{CLUSTER_ID}/metrics/query

接続エンドポイント

https://controller.api.${CLOUD_REGION}.zillizcloud.com

📘ノート

• ${CLOUD_REGION} を、デプロイに適したリージョンに置き換える必要があります。
• クラウドリージョンIDを取得するには、Zilliz Cloudコンソールまたはクラウドリージョンの一覧を参照してください。

shell

export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"

パラメータ

Authorizationstringheader必要

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

値の例： Bearer {{TOKEN}}

CLUSTER_IDstringpath必要

クラスターの ID。

値の例： inxx-xxxxxxxxxxxxxxxxx

リクエスト・ボディapplication/json

startstring必要

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

値の例： 2023-12-31T23:59:59Z

endstring必要

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

値の例： 2024-07-01T08:15:30Z

periodstring必要

メトリクスがレポートされる期間です。UTC の ISO 8601 duration 形式で指定します。start パラメータと end パラメータのいずれも設定されていない場合にこのパラメータを使用します。

可能な値：

P1D P1M

granularitystring必要

メトリクスがレポートされる時間間隔です。UTC の ISO 8601 duration 形式で指定します。最小の granularity は PT30S です。

metricQueriesarray必要

MetricQuery オブジェクトの配列。

[]metricQueriesobject必要

メトリクスに関する情報です。

namestring必要

照会するメトリクスの名前です。使用可能なメトリクスの詳細については、Metrics & Alerts Reference を参照してください。

可能な値：

CU_COMPUTATION CU_CAPACITY STORAGE_USE REQ_INSERT_COUNT REQ_BULK_INSERT_COUNT REQ_UPSERT_COUNT REQ_DELETE_COUNT REQ_SEARCH_COUNT REQ_QUERY_COUNT VECTOR_REQ_INSERT_COUNT VECTOR_REQ_BULK_INSERT_COUNT VECTOR_REQ_UPSERT_COUNT VECTOR_REQ_DELETE_COUNT VECTOR_REQ_SEARCH_COUNT REQ_INSERT_LATENCY_AVG REQ_INSERT_LATENCY_P99 REQ_UPSERT_LATENCY_AVG REQ_UPSERT_LATENCY_P99 REQ_DELETE_LATENCY_AVG REQ_DELETE_LATENCY_P99 REQ_SEARCH_LATENCY_AVG REQ_SEARCH_LATENCY_P99 REQ_QUERY_LATENCY_AVG REQ_QUERY_LATENCY_P99 SLOW_QUERY_COUNT REQ_FAIL_RATE_INSERT REQ_FAIL_RATE_BULK_INSERT REQ_FAIL_RATE_UPSERT REQ_FAIL_RATE_DELETE REQ_FAIL_RATE_SEARCH REQ_FAIL_RATE_QUERY ENTITIES_LOADED ENTITIES_INDEXED ENTITIES_COUNT COLLECTIONS_COUNT CLUSTER_WRITE_CAPACITY UNLOADED_COLLECTIONS_COUNT FLUSH_COUNT

statstring必要

メトリクスに適用する統計手法です。AVG は各メトリクスで利用可能な平均値、P99 はレイテンシ関連メトリクスの 99 パーセンタイル値です。

可能な値：

AVG P99

Examplebash

export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxxxx"

curl --request POST \
--url "${BASE_URL}/v1/clusters/${CLUSTER_ID}/metrics/query" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "start": "",
    "end": "",
    "period": "PT99H",
    "granularity": "PT5H",
    "metricQueries": [
        {
            "name": "CU_CAPACITY",
            "stat": "AVG"
        }
    ]
}'

レスポンス200 OK - application/json

照会したメトリクスの統計情報を返します。

Success

成功レスポンス。

codeinteger

レスポンスコード。

dataobject

レスポンスペイロードです。照会したメトリクスに関する情報を含むオブジェクトです。

resultsarray

結果オブジェクトの配列。

[]resultsobject

メトリクスに関する情報です。

namestring

メトリクスの名前です。

statstring

メトリクスに適用された統計関数です。

unitstring

メトリクスの測定単位です（例: percent）。

valuesarray

データポイントの配列。

[]valuesobject

データポイントの詳細です。

timestampstring

データポイントのタイムスタンプです。ISO 8601 形式で指定されます。

valuestring

The value of the metric at the given timestamp.

Failure

失敗レスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson

{
    "code": 200,
    "data": {
        "results": [
            {
                "name": "CU_COMPUTATION",
                "stat": "AVG",
                "unit": "percent",
                "values": [
                    {
                        "timestamp": "2024-07-23T16:09:53Z",
                        "value": "1.00"
                    },
                    {
                        "timestamp": "2024-07-23T22:09:53Z",
                        "value": "1.00"
                    },
                    {
                        "timestamp": "2024-07-24T04:09:53Z",
                        "value": "1.00"
                    }
                ]
            }
        ]
    }
}