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

オンデマンドクラスターの一覧表示 (V2)

List all on-demand clusters in the current project.

GET/v2/clusters/onDemandClusters
接続エンドポイント

https://api.cloud.zilliz.com

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

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

値の例： Bearer {{TOKEN}}
Acceptstringheader

application/json を使用します。

値の例： application/json
projectIdstringquery必要

クラスターを一覧表示する対象のプロジェクトの ID。指定しない場合は、デフォルトプロジェクト内のクラスターが一覧表示されます。

値の例： proj-xxxxxxxxxxxxxxxxxxxx
regionIdstringquery必要

クラスターを一覧表示する対象のクラウドリージョンの ID。指定しない場合は、すべてのリージョンのクラスターが一覧表示されます。

値の例： aws-us-west-2
bash
export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v2/clusters/onDemandClusters?projectId=proj-xxxxxxxxxxxxxxxxxxxx&regionId=aws-us-west-2" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス200 OK - application/json

オンデマンドクラスターの一覧を返します。

codeinteger

レスポンスコード。

dataobject
countinteger

オンデマンドクラスターの総数。

onDemandClustersarray

オンデマンドクラスターの一覧。

[]onDemandClustersobject

オンデマンドクラスター。

projectIdstring

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

値の例： proj-xxxxxxxxxxxxxxx
clusterIdstring

クラスターの ID。

値の例： inxx-xxxxxxxxxxxxxxx
clusterNamestring

クラスター名。

descriptionstring

オンデマンドクラスターの説明。

regionIdstring

クラスターが配置されているクラウドリージョン。

値の例： aws-us-west-2
cuSizeinteger

クラスターの CU サイズ。

statusstring

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

endpointstring

クラスターのパブリックエンドポイント。オンデマンドクラスターでは、このエンドポイントはオンデマンドコンピュートエンドポイントであり、プロジェクト内のすべてのオンデマンドクラスターで共有されます。検索およびクエリには、対象クラスターの ID とともにこれを使用します。

値の例： https://proj-xxxxxxxxxxxxxxx.aws-us-west-2.zillizcloud.com
privateLinkstring

クラスターのプライベートエンドポイント。Private Link が有効になっていない場合は空文字列です。

createdBystring

クラスターを作成したユーザーのメールアドレス。

createTimestring

クラスターが作成された時刻。UTC の ISO-8601 形式です。

autoSuspendinteger

クラスターに設定されたアイドル時の自動停止時間。指定した期間内にリクエストがない場合、クラスターは自動的に停止されます。値は秒数を表す整数です。たとえば、300 は 5 分を意味します。

Failurejson
{
    "code": 21119,
    "message": "The apikey is illegal."
}
Ctrl I