コレクションに関する情報のクエリ - DashVector - Alibaba Cloud ドキュメントセンター

このトピックでは、Java 用 SDK を使用して、既存のコレクションのステータスとスキーマ情報をクエリする方法について説明します。

前提条件

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

API 定義

Java

// class DashVectorClient

public Response<CollectionMeta> describe(String name);

例

説明

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

Java

import com.aliyun.dashvector.DashVectorClient;
import com.aliyun.dashvector.common.DashVectorException;
import com.aliyun.dashvector.models.CollectionMeta;
import com.aliyun.dashvector.models.responses.Response;

public class Main {
    public static void main(String[] args) throws DashVectorException {
        DashVectorClient client = new DashVectorClient("YOUR_API_KEY", "YOUR_CLUSTER_ENDPOINT");

        Response<CollectionMeta> response = client.describe("quickstart");

        System.out.println(response);
        // example output:
        // {
        //     "code":0,
        //     "message":"",
        //     "requestId":"cb468965-d86b-405a-87a4-a596e61c1240",
        //     "output":{
        //         "name":"quickstart",
        //         "dimension":4,
        //         "dataType":"FLOAT",
        //         "metric":"dotproduct",
        //         "status":"SERVING",
        //         "fieldsSchema":{
        //             "name":"STRING",
        //             "weight":"FLOAT",
        //             "age":"INT"
        //         },
        //         "partitionStatus":{
        //             "default":"SERVING"
        //         }
        //     }
        // }
    }
}

リクエストパラメーター

パラメーター	タイプ	必須	デフォルト値	説明
name	String	はい	-	既存のコレクションの名前。

レスポンスパラメーター

説明

Response<CollectionMeta> オブジェクトが返されます。これには、次の表に示すように、操作結果が含まれます。

メソッド	タイプ	説明	例
getCode()	int	返されたステータスコード。詳細については、「ステータスコード」をご参照ください。	0
getMessage()	String	返されたメッセージ。	success
getRequestId	String	リクエストの一意の ID。	19215409-ea66-4db9-8764-26ce2eb5bb99
getOutput()	CollectionMeta	詳細については、「CollectionMeta」をご参照ください。	`{ "name":"quickstart", "dimension":4, "dataType":"FLOAT", "metric":"dotproduct", "status":"SERVING", "fieldsSchema":{ "name":"STRING", "weight":"FLOAT", "age":"INT" }, "partitionStatus":{ "default":"SERVING" } }`
isSuccess()	Boolean	操作が成功したかどうかを指定します。	true