このトピックでは、Python 用 SDK を使用して、既存のコレクションすべてのリストを取得する方法について説明します。
前提条件
クラスターが作成されていること。詳細については、「クラスターの作成」をご参照ください。
API キーが取得されていること。詳細については、「API キーの管理」をご参照ください。
最新バージョンの SDK がインストールされていること。詳細については、「DashVector SDK のインストール」をご参照ください。
API 定義
Client.list() -> DashVectorResponse例
説明
コードを正しく実行するには、サンプルコード内の YOUR_API_KEY を実際の API キーに、YOUR_CLUSTER_ENDPOINT をクラスターのエンドポイントに置き換える必要があります。
import dashvector
client = dashvector.Client(
api_key='YOUR_API_KEY',
endpoint='YOUR_CLUSTER_ENDPOINT'
)
collections = client.list()
# list メソッドが正常に呼び出されたかどうかを確認します。
if collections:
# すべてのコレクションを表示します。
for collection in collections:
print(collection)
# コレクションの長さ。
print(len(collections))
# コレクションが存在するかどうかを確認します。
print('YOUR_COLLECTION_NAME' in collections)
else:
# 操作が失敗した場合、エラーメッセージを表示します。
print(collections)リクエストパラメーター
この操作には、操作固有のリクエストパラメーターはありません。
レスポンスパラメーター
説明
次の表に示すように、操作結果を含む DashVectorResponse オブジェクトが返されます。
パラメーター | タイプ | 説明 | 例 |
code | int | 返されたステータスコード。詳細については、「ステータスコード」をご参照ください。 | 0 |
message | str | 返されたメッセージ。 | success |
request_id | str | リクエストの一意の ID。 | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
output | list[str] | すべてのコレクションのリスト。 | ['my_collection1', 'my_collection2'] |