描述Partition_向量检索服务(VRS)-阿里云帮助中心

本文介绍如何通过Java SDK获取Collection中一个已存在的Partition的状态

前提条件

已创建Cluster：创建Cluster。
已获得API-KEY：API-KEY管理。
已安装最新版SDK：安装DashVector SDK。

接口定义

Java

// class DashVectorCollection

public Response<Status> describePartition(String name);

使用示例

说明

需要使用您的api-key替换示例中的YOUR_API_KEY、您的Cluster Endpoint替换示例中的YOUR_CLUSTER_ENDPOINT，代码才能正常运行。
本示例需要参考新建Collection提前创建好名称为quickstart的Collection。
本示例需要参考新建Partition提前创建好名称为shoes的Partition。

Java

import com.aliyun.dashvector.DashVectorClient;
import com.aliyun.dashvector.DashVectorCollection;
import com.aliyun.dashvector.common.DashVectorException;
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");
      	DashVectorCollection collection = client.get("quickstart");
      	
      	// 描述Partition
        Response<Status> response = collection.describePartition("shoes");

        System.out.println(response);
        // example output:
        // {"code":0,"message":"","requestId":"f554cde8-6147-42b5-b794-8cb9c0ae57da","output":"SERVING"}
    }
}

入参描述

参数	类型	必填	默认值	描述
name	String	是	-	Partition名称

出参描述

说明

返回结果为Response<Status>对象，Response<Status>对象中可获取本次操作结果信息，如下表所示。

方法	类型	描述	示例
getCode()	int	返回值，参考返回状态码说明	0
getMessage()	String	返回消息	success
getRequestId()	String	请求唯一id	19215409-ea66-4db9-8764-26ce2eb5bb99
getOutput()	String	参考Status	`INITIALIZED`：创建中 `SERVING`：服务中 `DROPPING`：删除中 `ERROR`：状态异常
isSuccess()	Boolean	判断请求是否成功	true