描述Collection
更新時間：
本文介紹如何通過Java SDK獲取已創(chuàng)建的Collection的狀態(tài)和Schema信息。
前提條件
已創(chuàng)建Cluster：創(chuàng)建Cluster。
已獲得API-KEY：API-KEY管理。
已安裝最新版SDK：安裝DashVector SDK。
接口定義
// class DashVectorClient
public Response<CollectionMeta> describe(String name);使用示例
說明
需要使用您的api-key替換示例中的YOUR_API_KEY、您的Cluster Endpoint替換示例中的YOUR_CLUSTER_ENDPOINT，代碼才能正常運行。
本示例需要參考新建Collection-使用示例提前創(chuàng)建好名稱為
quickstart的Collection。
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"
// }
// }
// }
}
}
入?yún)⒚枋?/h2>
參數(shù) | 類型 | 必填 | 默認值 | 說明 |
name | String | 是 | - | 已創(chuàng)建集合的名稱 |
出參描述
說明
返回結(jié)果為Response<CollectionMeta>對象，Response<CollectionMeta>對象中可獲取本次操作結(jié)果信息，如下表所示。
字段 | 類型 | 描述 | 示例 |
getCode() | int | 返回值，參考返回狀態(tài)碼說明 | 0 |
getMessage() | String | 返回消息 | success |
getRequestId | String | 請求唯一id | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
getOutput() | CollectionMeta | | |
isSuccess() | Boolean | 判斷請求是否成功 | true |
文檔內(nèi)容是否對您有幫助？