コレクションの詳細 (V2)
Describes the details of a collection.
https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530
- サービングクラスターを使用している場合は、クラスターエンドポイントを使用します。
Free & Serverless
https://{cluster-id}.serverless.{region}.vectordb.zillizcloud.comDedicated
https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530
${CLUSTER_ENDPOINT}を、あなたのZilliz Cloudクラスターのエンドポイントに置き換える必要があります。- エンドポイントを取得するには、Describe Cluster V2 APIを使用してレスポンスから値を抽出してください。
export CLUSTER_ENDPOINT="https://{cluster-id}.{region}.vectordb.zillizcloud.com:19530"
認証トークンは、適切な権限を持つAPIキー、またはコロン区切りのユーザー名とパスワードのペア（例: username:password）である必要があります。プロジェクトエンドポイントを使用する場合は、十分な権限を持つ有効なAPIキーのみが適用されます。
コレクションが属するデータベースの名前。存在しないデータベースに設定するとエラーになります。指定しない場合は、デフォルトのデータベースが使用されます。
対象コレクションの名前。 存在しないコレクションに設定するとエラーになります。
export TOKEN="db_admin:xxxxxxxxxxxxx"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/collections/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "test_collection"
}'
指定されたコレクションの詳細を返します。
レスポンスコード。
レスポンスペイロード。指定されたコレクションの詳細情報が含まれます。
コレクションに割り当てられたエイリアスのリスト。
コレクションのエイリアス。
このコレクションの主キーが自動的にインクリメントされるかどうか。
作成時にコレクションに割り当てられたID。
現在のコレクションの名前。
現在のコレクションの整合性レベル。
コレクションの説明。
スキーマ未定義のフィールドとその値をキーと値のペアで保存するために、$meta という予約済み動的フィールドが有効になっているかどうか。
このコレクションが外部コレクションの場合のJSONエンコードされた外部ソース構成です。Zilliz Cloudボリューム内のオブジェクトURLが適用されます。
このコレクションが外部コレクションの場合のJSONエンコードされた外部仕様です。このフィールドの内容は、コネクタの種類とソースデータの形式によって異なる場合があります。これには、ファイル形式やフィールドマッピングなどが含まれますが、これらに限定されません。
コレクションフィールドの配列。
フィールドオブジェクト。
現在のフィールドの名前。
現在のフィールドが主キーであるかどうかを示します。
現在のフィールドがパーティションキーであるかどうかを示します。
現在のフィールドが自動生成されたIDであるかどうかを示します。
現在のフィールドの説明。
現在のフィールドがnull値を許可するかどうかを示します。
現在のフィールドのデフォルト値。この値は、デフォルト値を持つフィールドでのみ使用できます。
現在のフィールドが関数の派生フィールドであるかどうかを示します。この値は、関数から派生したフィールドでのみ使用できます。
現在のフィールドのデータ型。
現在のフィールドの一意の識別子。
現在のフィールドのパラメーター。この値は、パラメーターを持つフィールドでのみ使用できます。
現在のフィールドの要素のデータ型。この値は、配列型のフィールドでのみ使用できます。
コレクション関数の配列。
関数オブジェクト。
現在の関数の名前。
現在の関数の説明。
現在の関数のタイプ。
現在の関数のID。
現在の関数の入力フィールド名。
入力フィールドの名前。
現在の関数の出力フィールド名。
出力フィールドの名前。
現在の関数のパラメーター。
作成されたインデックスの配列。
インデックスオブジェクト。
現在のインデックスの名前。
現在のインデックスに関連付けられたフィールドの名前。
現在のインデックスのメトリックタイプ。
現在のコレクションのロード状態。
コレクション内のパーティション数。
追加のコレクションプロパティの配列。
キーと値のペア形式のコレクションプロパティオブジェクト。
プロパティ名
The property value.
コレクション内の struct 配列フィールド。
struct 配列フィールドの詳細。
struct 配列フィールドの名前。
struct 配列フィールドの一意の識別子。
struct 配列フィールドの説明。
フィールドのデータ型。
ネストされたサブフィールド。各型は、struct フィールドのスカラー型またはベクトル型です。
struct 配列内のサブフィールドの詳細。
サブフィールドの名前。
サブフィールドの一意の識別子。
struct フィールドのスカラー型またはベクトル型。
要素型のパラメーター。
追加のフィールドパラメーター。
エラーメッセージを返します。
レスポンスコード。
エラーメッセージ。
{
"code": 0,
"data": {
"aliases": [],
"autoId": false,
"collectionID": 448707763883002000,
"collectionName": "test_collection",
"consistencyLevel": "Bounded",
"description": "",
"enableDynamicField": true,
"fields": [
{
"autoId": false,
"description": "",
"id": 100,
"name": "id",
"partitionKey": false,
"primaryKey": true,
"type": "Int64"
},
{
"autoId": false,
"description": "",
"id": 101,
"name": "vector",
"params": [
{
"key": "dim",
"value": "5"
}
],
"partitionKey": false,
"primaryKey": false,
"type": "FloatVector"
}
],
"indexes": [
{
"fieldName": "vector",
"indexName": "vector",
"metricType": "COSINE"
}
],
"load": "LoadStateLoaded",
"partitionsNum": 1,
"properties": []
}
}
{
"code": 0,
"data": {
"aliases": [],
"autoId": false,
"collectionID": 448707763883002000,
"collectionName": "test_collection",
"consistencyLevel": "Bounded",
"description": "",
"enableDynamicField": true,
"externalSource": "volume://volume-vdc/demo_lance/",
"externalSpec": "{\"format\":\"lance-table\"}",
"fields": [
{
"autoId": false,
"description": "",
"id": 100,
"name": "id",
"partitionKey": false,
"primaryKey": true,
"type": "Int64"
},
{
"autoId": false,
"description": "",
"id": 101,
"name": "vector",
"params": [
{
"key": "dim",
"value": "5"
}
],
"partitionKey": false,
"primaryKey": false,
"type": "FloatVector"
}
],
"indexes": [
{
"fieldName": "vector",
"indexName": "vector",
"metricType": "COSINE"
}
],
"load": "LoadStateLoaded",
"partitionsNum": 1,
"properties": []
}
}