查看角色详情

This operation describes the details of a specified role.

POST

/v2/vectordb/roles/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

roleNamestring必填项

角色名称。

export TOKEN="db_admin:xxxxxxxxxxxxx"

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

响应200 - application/json

SUCCESS

A success response.

codeinteger

响应码。

示例值：0

dataarray

响应载荷，为权限对象列表。

[]dataobject

A privilege item.

object_typestring

当前权限所属对象。

privilegestring

授予当前角色的权限名称。

object_namestring

授予当前角色的权限所属的对象名称。

grantorstring

被授予当前权限的用户名称。

FAILURE

A failure response.

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 0,
    "data": [
        {
            "dbName": "*",
            "grantor": "db_admin",
            "objectName": "*",
            "objectType": "Collection",
            "privilege": "IndexDetail"
        },
        {
            "dbName": "*",
            "grantor": "db_admin",
            "objectName": "*",
            "objectType": "Global",
            "privilege": "DescribeCollection"
        },
        {
            "dbName": "*",
            "grantor": "db_admin",
            "objectName": "*",
            "objectType": "Global",
            "privilege": "ShowCollections"
        }
    ]
}