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

Describe Cluster (V1)

ノート

Cluster の詳細を説明します。

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

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

📘ノート
shell
export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"
パラメータ
Authorizationstringheader必要

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

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

Cluster の ID。

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

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

Cluster の詳細を返します。

成功レスポンス。

codeinteger

レスポンスコード。

dataobject

Cluster の詳細を含むレスポンスペイロード。

clusterIdstring

Cluster の ID。

clusterNamestring

Cluster の名前。

projectIdstring

Cluster が属するプロジェクトの ID。

descriptionstring

Cluster の任意の説明。

regionIdstring

Cluster が存在するクラウドリージョンの ID。

cuTypestring

Cluster に関連付けられた CU のタイプ。

planstring

Cluster のサブスクリプションプラン。

statusstring

Cluster の現在のステータス。

connectAddressstring

Cluster のパブリックエンドポイント。パブリックネットワークからこのエンドポイントを使用して Cluster に接続できます。

privateLinkAddressstring

Cluster のプライベートエンドポイント。プライベートリンクを設定することで、同じクラウドリージョン内の VPS から Cluster にアクセスできるようになります。

createTimestring

Cluster が作成された時刻。

replicainteger

Cluster で使用されるレプリカ数。

cuSizeinteger

Cluster で使用される CU のサイズ。

storageSizeinteger<sint64>

Cluster のストレージサイズ。

snapshotNumberinteger

Cluster から作成されたスナップショットの数。

createProgressinteger

Cluster の作成進行状況。

値の範囲： 0≤ 100

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Ctrl I