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

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

現在のプロジェクト内のすべてのオンデマンドクラスターを一覧表示します。

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

クラスターの public endpoint。オンデマンドクラスターの場合、この endpoint はオンデマンドコンピュート endpoint であり、プロジェクト内のすべてのオンデマンドクラスター間で共有されます。検索やクエリでは、ターゲットのクラスター ID とともにこの endpoint を使用します。

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

クラスターの private endpoint。private link が有効でない場合は空の文字列です。

createdBystring

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

createTimestring

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

autoSuspendinteger

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

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