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

クラスターの詳細取得 (V2)

クラスターの詳細情報を取得します。

GET/v2/clusters/{CLUSTER_ID}
接続エンドポイント

https://api.cloud.zilliz.com

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

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

値の例: Bearer {{TOKEN}}
Acceptstringheader

application/json を使用します。

値の例: application/json
CLUSTER_IDstringpath必要

詳細情報を返す対象クラスターの ID。

値の例: inxx-xxxxxxxxxxxxxxx
bash
export TOKEN="YOUR_API_KEY"
export CLUSTER_ID="inxx-xxxxxxxxxxxxxxx"

curl --request GET \
--url "${BASE_URL}/v2/clusters/${CLUSTER_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス

指定したクラスターの詳細情報を返します。

codeinteger

レスポンスコード。

dataobject

レスポンスペイロード。

clusterIdstring

指定したクラスターの ID。

clusterNamestring

クラスター名。

projectIdstring

クラスターが属するプロジェクトの ID。

descriptionstring

クラスターの説明。

regionIdstring

クラスターをホストしているクラウドリージョンの ID。

cuTypestring

クラスターのタイプ。
これは専有クラスターにのみ適用されます。Free クラスターおよび Serverless クラスターでは、値は空です。

planstring

クラスターが属するプロジェクトのサブスクリプションプラン。指定可能な値は FreeServerlessStandardEnterprise です。

statusstring

クラスターの現在のステータス。

connectAddressstring

クラスターのパブリックエンドポイント。

privateLinkAddressstring

クラスターのプライベートリンク。

replicastring

クラスターのレプリカ数。

cuSizeinteger

クラスターの CU サイズ。Free クラスターおよび Serverless クラスターでは、値は常に 0 です。

値の範囲: 0≤ 256
storageSizeinteger

このクラスターで使用されているストレージサイズ。

snapshotNumberinteger

作成されたバックアップの数。

createProgressinteger

クラスターの作成進捗。

createTimestring

クラスターが作成された時刻。

deploymentOptionstring

クラスターのデプロイオプション。

autoscalingobject

クラスターのオートスケーリング設定。

cuobject

CU のオートスケーリング設定。

mininteger

オートスケーリングの最小 CU 数。このパラメーターと schedules は相互排他的です。

値の範囲: > 1≤ 256
maxinteger

オートスケーリングの最大 CU 数。このパラメーターと schedules は相互排他的です。

値の範囲: > 1≤ 256
schedulesarray

オートスケーリングスケジュール。このパラメーターと min/max は相互排他的です。

[]schedulesobject

オートスケーリングスケジュール。

cronstring

スケジュールを定義する Cron 式。

値の例: 0 0 * * *
targetinteger

このスケジュールの目標 CU 数。

replicaobject

レプリカのオートスケーリング設定。

mininteger

オートスケーリングの最小レプリカ数。このパラメーターと schedules は相互排他的です。

値の範囲: > 1≤ 10
maxinteger

オートスケーリングの最大レプリカ数。このパラメーターと schedules は相互排他的です。

値の範囲: > 1≤ 10
schedulesarray

オートスケーリングスケジュール。このパラメーターと min/max は相互排他的です。

[]schedulesobject

オートスケーリングスケジュール。

cronstring

スケジュールを定義する Cron 式。

値の例: 0 0 * * *
targetinteger

このスケジュールの目標レプリカ数。

globalClusterMetaobject

現在のクラスターがグローバルクラスターに属している場合、そのグローバルクラスターのメタデータ。それ以外の場合、このフィールドは null です。

globalClusterIdstring

グローバルクラスターの ID。

rolestring

グローバルクラスター内でのクラスターの役割。指定可能な値は PRIMARYSECONDARY です。

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Ctrl I