クラウドリージョンを一覧表示 (V1)

ノート

特定のクラウドプロバイダーで利用可能なすべてのクラウドリージョンを一覧表示します。

GET/v1/regions

接続エンドポイント

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

📘ノート

• ${CLOUD_REGION} を、デプロイに適したリージョンに置き換える必要があります。
• クラウドリージョンIDを取得するには、Zilliz Cloudコンソールまたはクラウドリージョンの一覧を参照してください。

shell

export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"

パラメータ

Authorizationstringheader必要

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

値の例： Bearer {{TOKEN}}

cloudIdstringquery

有効なクラウドプロバイダーの ID。

bash

export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v1/regions" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"

レスポンス200 OK - application/json

指定したクラウドプロバイダーが提供する利用可能なすべてのリージョンの一覧を返します。

Success

成功レスポンス。

codeinteger

レスポンスコード。

dataarray

クラウドリージョンに関する情報を含むオブジェクトであるレスポンスペイロード。

[]dataobject

クラウドリージョン。

cloudIdstring

クラウドプロバイダーの ID。

regionIdstring

クラウドリージョンの ID。

domainstring

Zilliz Cloud open API endpoint のベース URL。

Failure

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

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。