授予角色特權或特權群組

建立角色後，就可以授予角色權限。本指南介紹如何授予角色特權或特權群組。

授予角色一個特權或特權群組

Milvus 2.5 引入了新版本的 API，簡化了授予操作。向角色授予權限時，不再需要查找對象類型。以下是參數和相對應的解釋。

role_name：需要授予特權或特權群組的目標角色名稱。
Resource: 資源：特權的目標資源，可以是特定的實例、資料庫或集合。

下表說明如何在client.grantV2() 方法中指定資源。

層級	資源	授予方法	註解
集合	特定的集合	`client.grant_privilege_v2( role_name="roleA", privilege="CollectionAdmin", collection_name="col1", db_name="db1" )`	輸入目標集合的名稱以及目標集合所屬資料庫的名稱。
集合	特定資料庫下的所有集合	`client.grant_privilege_v2( role_name="roleA", privilege="CollectionAdmin", collection_name="*", db_name="db1" )`	輸入目標資料庫的名稱和通配符`*` 作為集合名稱。
資料庫	特定資料庫	`client.grant_privilege_v2( role_name="roleA", privilege="DatabaseAdmin", collection_name="*", db_name="db1" )`	輸入目標資料庫的名稱和通配符`*` 作為集合名稱。
資料庫	當前實例下的所有資料庫	`client.grant_privilege_v2( role_name="roleA", privilege="DatabaseAdmin", collection_name="", db_name="" )`	輸入`` 作為資料庫名稱，並輸入`` 作為集合名稱。
實例	目前的實例	`client.grant_privilege_v2( role_name="roleA", privilege="ClusterAdmin", collection_name="", db_name="" )`	輸入`` 作為資料庫名稱，輸入`` 作為集合名稱。

權限：您需要賦予角色的特定權限或權限群。目前，Milvus 提供 56 種可授予的特權。下表列出了 Milvus 中的特權。

下表中的類型欄是用戶為了方便您快速查找特權，僅用於分類目的。在授予特權時，您不需要瞭解其類型。您只需輸入相應的特權。

類型	特權	說明	客戶端的相關 API 描述
資料庫權限	列出資料庫	檢視目前實例中的所有資料庫	列出資料庫
	描述資料庫	檢視資料庫的詳細資訊	描述資料庫
	建立資料庫	建立資料庫	建立資料庫
	丟棄資料庫	丟棄資料庫	刪除資料庫
	更改資料庫	修改資料庫的屬性	更改資料庫
收集權限	GetFlushState	檢查資料集刷新作業的狀態	GetFlushState
	取得載入狀態	檢查集合的載入狀態	取得載入狀態
	取得載入進度	檢查集合的載入進度	取得載入進度
	顯示收藏集	檢視所有具有收藏權限的收藏集	顯示收藏集
	列出別名	檢視集合的所有別名	列出別名
	描述收藏集	檢視集合的詳細資訊	描述集合
	描述別名	檢視別名的詳細資訊	描述別名
	取得統計資料	取得集合的統計資料（例如集合中的實體數量）	取得集合統計資料
	建立集合	建立一個集合	建立集合
	丟棄集合	丟棄收藏集	丟棄收藏集
	載入	載入集合	LoadCollection/GetLoadingProgress/GetLoadState
	釋放	釋放集合	釋放集合
	刷新	將集合中的所有實體暫存到封存的區段。任何在 flush 操作之後插入的實體都會儲存在新的區段中。	沖洗/GetFlushState
	壓縮	手動觸發壓縮	壓縮
	重新命名集合	重新命名一個集合	重新命名集合
	建立別名	為集合建立別名	建立別名
	刪除別名	刪除集合的別名	刪除別名
	全部清除	清除資料庫中的所有集合	全部清除
分區權限	有分割區	檢查磁碟分割是否存在	HasPartition
	顯示分割區	檢視集合中的所有磁碟分割	顯示分割區
	建立磁碟分割	建立磁碟分割	建立磁碟分割
	丟棄磁碟分割	刪除磁碟分割	刪除分割區
索引權限	索引詳細資料	檢視索引的詳細資訊	DescribeIndex/GetIndexState/GetIndexBuildProgress
	建立索引	建立索引	建立索引
	刪除索引	刪除索引	刪除索引
資源管理權限	負載平衡	達成負載平衡	負載平衡
	建立資源群組	建立資源群組	建立資源群組
	丟棄資源群組	刪除資源群組	刪除資源群組
	更新資源群組	更新資源群組	更新資源群組
	描述資源群組	檢視資源群組的詳細資訊	描述資源群組
	列出資源群組	檢視目前實例的所有資源群組	列出資源群組
	轉移節點	在資源群組之間轉移節點	轉移節點
	傳送複本	在資源群組之間傳輸複本	傳輸複本
	備份 RBAC	為目前實例中所有 RBAC 相關作業建立備份	備份 RBAC
	還原 RBAC	還原當前實例中所有 RBAC 相關作業的備份	還原 RBAC
實體權限	查詢	進行查詢	查詢
	搜尋	進行搜尋	搜尋
	插入	插入實體	插入
	刪除	刪除實體	刪除
	上移	插入實體	上傳
	匯入	大量插入或匯入實體	大量插入/匯入
RBAC 權限	建立所有權	建立使用者或角色	建立使用者/建立角色
	更新使用者	更新使用者的密碼	更新憑證
	刪除所有權	刪除使用者密碼或角色	刪除憑證/刪除角色
	選擇所有權	檢視授予特定角色的所有使用者	選擇角色/選擇授予
	管理所有權	管理使用者或角色，或授予使用者角色	操作使用者角色/操作權限/操作權限 V2
	選擇使用者	檢視授予使用者的所有角色	選擇使用者
	建立特權群組	建立特權群組	建立特權群組
	刪除特權群組	刪除特權群組	刪除特權群組
	列出特權群組	檢視目前實例中的所有特權群組	列出特權群組
	操作特權群組	在特權群組中加入特權或移除特權	操作特權群組

下面的示例演示了如何授予default 資料庫下collection_01 上的PrivilegeSearch 特權，以及授予角色role_a 名為privilege_group_1 的特權組。

Python Java Go NodeJS cURL

from pymilvus import MilvusClient

client = MilvusClient(
    uri="http://localhost:19530",
    token="root:Milvus"
)

client.grant_privilege_v2(
    role_name="role_a",
    privilege="Search",
    collection_name='collection_01',
    db_name='default',
)
    
client.grant_privilege_v2(
    role_name="role_a",
    privilege="privilege_group_1",
    collection_name='collection_01',
    db_name='default',
)

client.grant_privilege_v2(
    role_name="role_a",
    privilege="ClusterReadOnly",
    collection_name='*',
    db_name='*',
)

import io.milvus.v2.service.rbac.request.GrantPrivilegeReqV2

client.grantPrivilegeV2(GrantPrivilegeReqV2.builder()
        .roleName("role_a")
        .privilege("Search")
        .collectionName("collection_01")
        .dbName("default")
        .build());

client.grantPrivilegeV2(GrantPrivilegeReqV2.builder()
        .roleName("role_a")
        .privilege("privilege_group_1")
        .collectionName("collection_01")
        .dbName("default")
        .build());

client.grantPrivilegeV2(GrantPrivilegeReqV2.builder()
        .roleName("role_a")
        .privilege("ClusterReadOnly")
        .collectionName("*")
        .dbName("*")
        .build());

import (
    "context"
    "fmt"

    "github.com/milvus-io/milvus/client/v2/milvusclient"
)

ctx, cancel := context.WithCancel(context.Background())
defer cancel()

client, err := milvusclient.New(ctx, &milvusclient.ClientConfig{
    Address: "localhost:19530",
    APIKey:  "root:Milvus",
})
if err != nil {
    fmt.Println(err.Error())
    // handle error
}
defer client.Close(ctx)

err = client.GrantV2(ctx, milvusclient.NewGrantV2Option("role_a", "Search", "default", "collection_01"))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

err = client.GrantV2(ctx, milvusclient.NewGrantV2Option("role_a", "privilege_group_1", "default", "collection_01"))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

err = client.GrantV2(ctx, milvusclient.NewGrantV2Option("role_a", "ClusterReadOnly", "*", "*"))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

const { MilvusClient, DataType } = require("@zilliz/milvus2-sdk-node")

const address = "http://localhost:19530";
const token = "root:Milvus";
const client = new MilvusClient({address, token});

await client.grantPrivilegeV2({
    role: "role_a",
    privilege: "Search"
    collection_name: 'collection_01'
    db_name: 'default',
});
    
await client.grantPrivilegeV2({
    role: "role_a",
    privilege: "privilege_group_1"
    collection_name: 'collection_01'
    db_name: 'default',
});

await client.grantPrivilegeV2({
    role: "role_a",
    privilege: "ClusterReadOnly"
    collection_name: '*'
    db_name: '*',
});

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/roles/grant_privilege_v2" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "roleName": "role_a",
    "privilege": "Search",
    "collectionName": "collection_01",
    "dbName":"default"
}'

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/roles/grant_privilege_v2" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "roleName": "role_a",
    "privilege": "privilege_group_1",
    "collectionName": "collection_01",
    "dbName":"default"
}'

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/roles/grant_privilege_v2" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "roleName": "role_a",
    "privilege": "ClusterReadOnly",
    "collectionName": "*",
    "dbName":"*"
}'

描述角色

下面的示例演示了如何使用describe_role 方法查看授予角色role_a 的權限。

Python Java Go NodeJS cURL

from pymilvus import MilvusClient

client.describe_role(role_name="role_a")

import io.milvus.v2.service.rbac.response.DescribeRoleResp;
import io.milvus.v2.service.rbac.request.DescribeRoleReq

DescribeRoleReq describeRoleReq = DescribeRoleReq.builder()
        .roleName("role_a")
        .build();
DescribeRoleResp resp = client.describeRole(describeRoleReq);
List<DescribeRoleResp.GrantInfo> infos = resp.getGrantInfos();

import "github.com/milvus-io/milvus/client/v2/milvusclient"

role, err := client.DescribeRole(ctx, milvusclient.NewDescribeRoleOption("role_a"))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

await client.describeRole({roleName: 'role_a'});

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

以下是一個輸出範例。

{
     "role": "role_a",
     "privileges": [
         {
             "collection_name": "collection_01",
             "db_name": "default",
             "role_name": "role_a",
             "privilege": "Search",
             "grantor_name": "root"
         },
         "privilege_group_1"
     ]
}

撤銷角色的特權或特權群組

下面的示例演示了如何撤銷default 資料庫下collection_01 上的特權PrivilegeSearch 以及授予角色role_a 的特權組privilege_group_1 。

Python Java Go NodeJS cURL

client.revoke_privilege_v2(
    role_name="role_a",
    privilege="Search",
    collection_name='collection_01',
    db_name='default',
)
    
client.revoke_privilege_v2(
    role_name="role_a",
    privilege="privilege_group_1",
    collection_name='collection_01',
    db_name='default',
)

client.revoke_privilege_v2(
    role_name="role_a",
    privilege="ClusterReadOnly",
    collection_name='*',
    db_name='*',
)

import io.milvus.v2.service.rbac.request.RevokePrivilegeReqV2

client.revokePrivilegeV2(RevokePrivilegeReqV2.builder()
        .roleName("role_a")
        .privilege("Search")
        .collectionName("collection_01")
        .dbName("default")
        .build());

client.revokePrivilegeV2(RevokePrivilegeReqV2.builder()
        .roleName("role_a")
        .privilege("privilege_group_1")
        .collectionName("collection_01")
        .dbName("default")
        .build());

client.revokePrivilegeV2(RevokePrivilegeReqV2.builder()
        .roleName("role_a")
        .privilege("ClusterReadOnly")
        .collectionName("*")
        .dbName("*")
        .build());

err = client.RevokePrivilegeV2(ctx, milvusclient.NewRevokePrivilegeV2Option("role_a", "Search", "collection_01").
        WithDbName("default"))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

err = client.RevokePrivilegeV2(ctx, milvusclient.NewRevokePrivilegeV2Option("role_a", "privilege_group_1", "collection_01").
    WithDbName("default"))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

err = client.RevokePrivilegeV2(ctx, milvusclient.NewRevokePrivilegeV2Option("role_a", "ClusterReadOnly", "*").
    WithDbName("*"))
if err != nil {
    fmt.Println(err.Error())
    // handle error
}

await client.revokePrivilegeV2({
    role: 'role_a',
    privilege: 'Search',
    collection_name: 'collection_01',
    db_name: 'default'
});

await client.revokePrivilegeV2({
    role: 'role_a',
    collection_name: 'collection_01',
    privilege: 'Search',
    db_name: 'default'
});

await client.revokePrivilegeV2({
    role: 'role_a',
    collection_name: '*',
    privilege: 'ClusterReadOnly',
    db_name: '*'
});

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/roles/revoke_privilege_v2" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "roleName": "role_a",
    "privilege": "Search",
    "collectionName": "collection_01",
    "dbName":"default"
}'

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/roles/revoke_privilege_v2" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "roleName": "role_a",
    "privilege": "Search",
    "collectionName": "collection_01",
    "dbName":"default"
}'

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/roles/revoke_privilege_v2" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
--header "Request-Timeout: 10" \
-d '{
    "roleName": "role_a",
    "privilege": "ClusterReadOnly",
    "collectionName": "*",
    "dbName":"*"
}'

免費嘗試托管的 Milvus

Zilliz Cloud 無縫接入，由 Milvus 提供動力，速度提升 10 倍。

開始使用

反饋

這個頁面有幫助嗎？

授予角色特權或特權群組

授予角色一個特權或特權群組

描述角色

撤銷角色的特權或特權群組

目錄

免費嘗試托管的 Milvus

反饋