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

Private Endpoint Service を一覧表示 (V2)

クラウドリージョン全体で利用可能なプライベートエンドポイントサービスを一覧表示します。

GET/v2/privateEndpointServices
接続エンドポイント

https://${CLUSTER_ENDPOINT}

📘ノート
  • ${CLUSTER_ENDPOINT} を、あなたのZilliz Cloudクラスターのエンドポイントに置き換える必要があります。
  • エンドポイントを取得するには、Describe Cluster V2 APIを使用してレスポンスから値を抽出してください。
shell
export CLUSTER_ENDPOINT=""
パラメータ
Authorizationstringheader必要

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

値の例： Bearer {{TOKEN}}
projectIdstringquery

利用可能なサービスをスコープするために使用するプロジェクトの ID。

値の例： proj-xxxxxxxxxxxxxxxxxxx
regionIdstringquery

サービスをフィルタリングするために使用するクラウドリージョンの ID。

currentPageintegerquery

返すページ番号。最初のページは 1 です。

値の例： 1
pageSizeintegerquery

ページごとに返す項目数。1 から 100 の範囲外の値にはデフォルト値の 10 が使用されます。

値の例： 10
bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

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

成功した結果またはエラーメッセージを返します。

成功したレスポンス。

codeinteger必要

レスポンスコード。

値の例： 0
dataobject必要

ページングされたプライベートエンドポイントサービスのリスト。

endpointServicesarray

プライベートエンドポイントサービス。

[]endpointServicesobject

クラウドリージョンで利用可能なプライベートエンドポイントサービス。

regionIdstring

クラウドリージョン ID。

cloudIdstring

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

endpointServicestring

エンドポイントサービス名。

whitelistRequiredboolean

サービスが外部クラウドアカウントのホワイトリストへの追加を必要とするかどうか。

currentPageinteger

現在のページ番号。

pageSizeinteger

ページごとの項目数。

countinteger

一致するサービスの総数。

失敗したレスポンス。

codeinteger必要

レスポンスコード。

messagestring必要

エラーメッセージ。

Ctrl I