查看 Alias 详情

This operation describes the details of a specific alias.

POST

/v2/vectordb/aliases/describe

集群 Endpoint

该 API 的 Base URL 格式如下：

https://${CLUSTER_ENDPOINT}

📘说明

• 你需要填入您的 Zilliz Cloud 集群的 ${CLUSTER_ENDPOINT}。
• 您可以参考 On Zilliz Cloud 控制台或使用 查看集群详情 V2 来获取集群的 Endpoint.

export CLUSTER_ENDPOINT=""

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 username:password。

示例值：Bearer {{TOKEN}}

请求体application/json

aliasNamestring必填项

目标别名。

export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/aliases/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
    "aliasName": "alice"
}'

响应200 - application/json

SUCCESS

codeinteger

响应码。

示例值：0

dataobject

响应负载，包含了指定 Collection 别名的详细信息。

collectionNamestring

当前别名所属的 Collection 名称。

aliasNamestring

当前别名。

FAILURE

Returns an error message.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": {
        "aliasName": "alice",
        "collectionName": "quick_setup",
        "dbName": "default"
    }
}