オンデマンドクラスターの詳細を表示(V2)
Describe the details of a specific on-demand cluster in the current project.
GET/v2/clusters/onDemandClusters/{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/onDemandClusters/${CLUSTER_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Accept: application/json" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス200 OK - application/json
特定のオンデマンドクラスターの詳細を返します。
codeinteger
レスポンスコード。
dataobject
現在のクラスターの詳細
propertiesobject
projectIdstring
プロジェクトのID。
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
クラスターのプライベートエンドポイント。プライベートリンクが有効でない場合、これは空文字列です。
createdBystring
クラスターを作成したユーザーのメールアドレス。
createTimestring
クラスターが作成された時刻(UTC ISO-8601形式)。
autoSuspendinteger
クラスターに設定された自動一時停止のアイドル時間。指定された期間内にリクエストがない場合、クラスターは自動的に一時停止されます。値は秒数を表す整数です。たとえば、300 は5分を意味します。
Failurejson
{
"code": 21119,
"message": "The apikey is illegal."
}