接口定义
describe_user() 接口用于查询指定用户的信息，包括用户的创建时间、拥有的权限列表。
def describe_user(self, user: str) -> dict:
使用示例
import tcvectordbfrom tcvectordb.model.enum import ReadConsistency#create a database client objectclient = tcvectordb.RPCVectorDBClient(url='http://10.0.X.X:80', username='root', key='eC4bLRy2va******************************', read_consistency=ReadConsistency.EVENTUAL_CONSISTENCY, timeout=30)res = client.describe_user(user='app_user')print(res)
入参描述
参数名 | 参数含义 | 子参数 | 数据类型 | 是否必填 | 参数配置 |
user | 需查询的用户名 | - | string | 是 | 指定需查询的用户名。 说明： root 用户享有最高权限级别，无法被任何账号（包括其自身）删除或修改其权限。 |
出参描述
{"code": 0,"msg": "Operation success","user": "app_user","createTime": "2024-12-27 16:47:25","privileges": [{"resource": "db0.*","actions": ["read"]},{"resource": "db1.coll1","actions": ["readWrite"]}]}
参数名 | 子参数 | 参数配置 |
user | - | 查询的用户名。 |
createTime | - | 用户创建时间。 |
privileges | resource | 用户可操作的资源对象层级。 全局：对实例下的所有 DB 和 Collection 对象授权。配置方式： "resource": "*.*"。 DB 层级：对某个 DB 授权，包括该 DB 下的所有 Collection。配置方式： "resource": "db0.*"，其中，db0 指授权的数据库名。 Collection 层级：对某个特定集合授权，配置方式为为 "resource": "db0.test_coll"其中，db0 指授权的数据库名，test_coll 为授权的集合名。 |
| actions | 用户可操作的权限。 dbAdmin：允许执行创建（create）、删除（drop）、清空（truncate）等数据定义语言（DDL）操作。 read：仅限于执行查询（query）和搜索（search）等读取操作，禁止进行任何数据修改。 readWrite：允许执行查询（query）、搜索（search）等读取操作，以及插入（upsert）、更新（update）等写入操作。 |
