Python 用 SDK を使用してコレクション内のパーティションのステータスをクエリする - DashVector

このトピックでは、Python 用 SDK を使用して、コレクション内の既存のパーティションのステータスをクエリする方法について説明します。

前提条件

クラスターが作成されていること。詳細については、クラスターの作成を参照してください。
APIキーが取得されていること。詳細については、APIキーの管理を参照してください。
最新バージョンの SDK がインストールされていること。詳細については、DashVector SDK のインストールを参照してください。

API 定義

Python

Collection.describe_partition(name: str) -> DashVectorResponse

例

説明

コードを正しく実行するには、サンプルコード内の YOUR_API_KEY を実際の API キーに、YOUR_CLUSTER_ENDPOINT をクラスターのエンドポイントに置き換える必要があります。
quickstart という名前のコレクションを事前に作成する必要があります。詳細については、コレクションの作成トピックの「例」セクションを参照してください。
shoes という名前のパーティションを事前に作成する必要があります。詳細については、パーティションの作成トピックの「例」セクションを参照してください。

Python

import dashvector

client = dashvector.Client(
    api_key='YOUR_API_KEY',
    endpoint='YOUR_CLUSTER_ENDPOINT'
)
collection = client.get(name='quickstart')

ret = collection.describe_partition('shoes')

print(ret)
# example output: 出力例
# {"request_id":"296267a7-68e2-483a-87e6-5992d85a5806","code":0,"message":"","output":"SERVING"}

リクエストパラメーター

パラメーター	型	デフォルト値	説明
name	str	-	パーティションの名前。

レスポンスパラメーター

説明

次の表に示すように、操作結果を含む DashVectorResponse オブジェクトが返されます。

パラメーター	型	説明	例
code	int	返されたステータスコード。詳細については、ステータスコードを参照してください。	0
message	str	返されたメッセージ。	success
request_id	str	リクエストの一意の ID。	19215409-ea66-4db9-8764-26ce2eb5bb99
output	str	詳細については、ステータスを参照してください。