帮你快速理解、总结文档立即下载

配置与配额

最近更新时间:2026-08-27 17:42:00
我的收藏

接口介绍

MetadataClient 提供以下配置与配额接口,用于查询实例配额上限和管理用户级别的配置项。
get_instance_quota:获取当前实例的配额上限信息(如用户数、团队数上限等)。
get_user_config:获取用户的配置项值。
set_user_config:设置用户的配置项值。

导入

from tencentdb_agent_memory.v3 import MetadataClient

方法签名

def get_instance_quota(self) -> Dict[str, Any]
def get_user_config(self, p: Dict[str, Any]) -> Dict[str, Any]
def set_user_config(self, p: Dict[str, Any]) -> Dict[str, Any]

使用示例

get_instance_quota

from tencentdb_agent_memory.v3 import MetadataClient

metadata = MetadataClient(
endpoint="https://memory.tdai.tencentyun.com",
api_key="sk-xxxxxxxxxxxxxxxx",
service_id="tdai-mem-xxxxxxxx",
)

resp = metadata.get_instance_quota()
print(resp["max_users"], resp["max_teams"])

get_user_config

resp = metadata.get_user_config({
"user_id": "user-123", # 必填,用户 ID
"key": "language", # 必填,配置项 key
})
print(resp)

set_user_config

resp = metadata.set_user_config({
"user_id": "user-123", # 必填,用户 ID
"key": "language", # 必填,配置项 key
"value": "zh-CN", # 必填,配置项值
})
print(resp)

请求参数

get_instance_quota

无需请求参数。

get_user_config

参数名
类型
必填
描述说明
user_id
str
用户 ID
key
str
配置项键名

set_user_config

参数名
类型
必填
描述说明
user_id
str
用户 ID
key
str
配置项键名
value
str
配置项值

响应示例

get_instance_quota

{
"max_users": 10000,
"max_teams": 500,
"max_agents": 5000,
"max_tasks": 50000,
"max_assets": 100000
}

get_user_config

{
"user_id": "user-123",
"key": "language",
"value": "zh-CN",
"updated_at_ms": 1723968000000
}

set_user_config

{
"user_id": "user-123",
"key": "language",
"value": "zh-CN",
"updated_at_ms": 1723968000000
}

响应参数说明

参数名
类型
参数含义
max_users
int
实例可创建的用户数上限
max_teams
int
实例可创建的团队数上限
max_agents
int
实例可创建的 Agent 数上限
max_tasks
int
实例可创建的 Task 数上限
max_assets
int
实例可创建的资产数上限
user_id
str
用户 ID
key
str
配置项键名
value
str
配置项值
updated_at_ms
int
最后更新时间,Unix 时间戳,单位为毫秒

错误码

错误码
触发场景
处理建议
400
请求参数不合法(如 key 为空)
检查参数是否符合约束条件
401
API Key 无效或缺失
检查 Bearer Token 配置
404
配置项不存在
确认 key 是否正确,或先通过 set_user_config 设置
500
服务内部错误
稍后重试