本文介紹如何通過HTTP API獲取一個已創建的Collection的狀態和Schema信息。
前提條件
Method與URL
GET https://{Endpoint}/v1/collections/{CollectionName}使用示例
說明
需要使用您的api-key替換示例中的YOUR_API_KEY、您的Cluster Endpoint替換示例中的YOUR_CLUSTER_ENDPOINT，代碼才能正常運行。
本示例需要參考新建Collection-使用示例提前創建好名稱為
quickstart的Collection
curl -H 'dashvector-auth-token: YOUR_API_KEY' \
https://YOUR_CLUSTER_ENDPOINT/v1/collections/quickstart
# example output:
# {
# "request_id": "8d3ac14e-5382-4736-b77c-4318761ddfab",
# "code": 0,
# "message": "",
# "output": {
# "name": "quickstart",
# "dimension": 4,
# "dtype": "FLOAT",
# "metric": "dotproduct",
# "fields_schema": {
# "name": "STRING",
# "age": "INT",
# "height": "FLOAT"
# },
# "status": "SERVING",
# "partitions": {
# "shoes": "SERVING",
# "default": "SERVING"
# }
# }
# }入參描述
參數 | Location | 類型 | 必填 | 說明 |
{Endpoint} | path | str | 是 | Cluster的Endpoint，可在控制臺Cluster詳情中查看 |
{CollectionName} | path | str | 是 | 您已創建的Collection名稱 |
dashvector-auth-token | header | str | 是 | api-key |
出參描述
字段 | 類型 | 描述 | 示例 |
code | int | 返回值，參考返回狀態碼說明 | 0 |
message | str | 返回消息 | success |
request_id | str | 請求唯一id | 19215409-ea66-4db9-8764-26ce2eb5bb99 |
output | object |
文檔內容是否對您有幫助？