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

Collection の詳細取得 (V1)

ノート

コレクションの詳細を取得します。

GET/v1/vector/collections/describe
接続エンドポイント

https://${CLUSTER_ENDPOINT}

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

認証トークンには、適切な権限を持つ API key、またはusername:password のようにコロンで連結した username と password の組を指定する必要があります。

値の例： Bearer {{TOKEN}}
collectionNamestringquery必要

詳細を取得するコレクションの名前。

dbNamestringquery

データベースの名前。

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

curl --request GET \
--url "${CLUSTER_ENDPOINT}/v1/vector/collections/describe?collectionName=undefined" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス200 OK - application/json

指定したコレクションの詳細を返します。

codeinteger

レスポンスコード。

dataobject

コレクションの詳細を含むレスポンスペイロード。

collectionNamestring

コレクションの名前。

descriptionstring

コレクションの任意の説明。

fieldsarray

フィールド配列

[]fieldsobject

フィールドオブジェクト

autoIdboolean

主キーが自動インクリメントされるかどうか。このフィールドは、現在のフィールドが主キーである場合にのみ適用されます。

descriptionstring

フィールドの任意の説明。

namestring

フィールドの名前。

primaryKeyboolean

このフィールドが主フィールドかどうか。

typestring

このフィールド内の値のデータ型。

indexesarray

インデックス配列

[]indexesobject

インデックスオブジェクト

fieldNamestring

インデックス化されたフィールドの名前。

indexNamestring

生成されたインデックスファイルの名前。

metricTypestring

ベクトル間の類似度の測定に使用される metric type

loadstring

コレクションのロード状態。

enableDynamicFieldboolean

このコレクションで dynamic field 機能が有効かどうか。

失敗レスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 200,
    "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": []
    }
}
Ctrl I