Skip to content
MilvusNode SDK
Sections

Describe role

Markdown

Copy for agent

Connection and CORS help

Use HTTPS for remote clusters or HTTP on loopback. Requests go directly from your browser to the endpoint. When copying an authenticated cURL command, set MILVUS_TOKEN in your shell.

For cross-origin requests, configure the endpoint to answer OPTIONS and allow the docs origin, POST, Content-Type, and Authorization if you use a token. Try the copied cURL command to troubleshoot outside the browser.

POST/v2/vectordb/roles/describe

{
  "dbName": "default",
  "roleName": "catalog_reader"
}

Example response

{
  "code": 0,
  "data": [
    {
      "objectType": "Collection",
      "objectName": "books",
      "privilege": "Search",
      "dbName": "default",
      "grantor": "root"
    }
  ],
  "description": "Read access for the catalog application"
}
cURL command
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/roles/describe' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "dbName": "default",
  "roleName": "catalog_reader"
}'

Inspect a role and the privileges granted to it.

Request fields

dbName string
Database name. Operations on collections use default when omitted.
roleName string (required)
Milvus role name.
description string
Human-readable description.

See HttpClient.describeRole for the Node.js SDK method.