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

クラスターを一覧表示 (V1)

ノート

指定したクラウドリージョン内のすべてのクラスターを一覧表示します。

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

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}}
pageSizeintegerquery

各ページで返されるレコード数。

値の例： 0
currentPageintegerquery

現在のページ番号。

値の例： 0
bash
export TOKEN="YOUR_API_KEY"

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

クラスターの一覧を返します。

クラスターの一覧を返します。

codeinteger

レスポンスコード。

dataobject

クラスターの一覧を含むレスポンスペイロード。

countinteger

返されるクラスターの総数。

currentPageinteger

結果内の現在のページ。

pageSizeinteger

結果内の1ページあたりのクラスター数。

clustersarray

クラスターの詳細を含む配列。

[]clustersobject

クラスター。

clusterIdstring

クラスターの ID。

clusterNamestring

クラスター名。

descriptionstring

クラスターに関する任意の説明。

regionIdstring

クラスターが存在するリージョンの ID。

clusterTypestring

クラスターに関連付けられた CU のタイプ。

planstring

クラスターに関連付けられたサブスクリプションプラン。

cuSizeinteger

クラスターに関連付けられた CU のサイズ。

statusstring

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

connectAddressstring

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

privateLinkAddressstring

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

projectIdstring

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

createTimestring

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

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Ctrl I