腾讯云数据库 AI 服务用户密钥管理（Metadata）

一、接口介绍

Metadata 用户密钥管理接口用于管理用户的 API 密钥。共5个接口：

接口	方法	功能
/v3/user-key/create	POST	创建用户密钥
/v3/user-key/list	POST	列出用户密钥
/v3/user-key/get	POST	获取密钥详情
/v3/user-key/revoke	POST	撤销密钥
/v3/user-key/update	POST	更新密钥

二、创建用户密钥

为指定用户创建新的 API 密钥。

POST /v3/user-key/create

三、请求参数

字段	类型	必选	说明
user_id	string	是	用户 ID
name	string	否	密钥名称/备注

四、请求示例

curl -i -X POST \\ -H 'Content-Type: application/json' \\ -H 'Authorization: Bearer *********************************' \\ -H "x-tdai-service-id: tdai-mem-xxxxxxxx" \\ https://memory.tdai.tencentyun.com/v3/user-key/create \\ -d '{"user_id":"user-123","name":"dev-key"}'

五、响应示例

{ "code":0, "message":"ok", "request_id":"req-7fd3b2dd", "data":{ "key_id":"key-abc123", "key":"sk-mem-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "name":"dev-key", "created_at_ms":1758096000000 }}

六、响应 data

字段	类型	说明
key_id	string	密钥唯一标识 ID
key	string	密钥值（仅创建时返回一次）
name	string	密钥名称
created_at_ms	int	创建时间

七、列出用户密钥

列出指定用户的全部密钥。

POST /v3/user-key/list

八、请求参数

字段	类型	必选	说明
user_id	string	是	用户 ID

九、请求示例

十、响应示例

{ "code":0, "message":"ok", "request_id":"req-7fd3b2dd", "data":{ "items":[ { "key_id":"key-abc123", "name":"dev-key", "status":"active", "created_at_ms":1758096000000 }, { "key_id":"key-def456", "name":"prod-key", "status":"revoked", "created_at_ms":1758182400000 } ] }}

十一、响应 data

字段	类型	说明
items	array	密钥列表
items[].key_id	string	密钥 ID
items[].name	string	密钥名称
items[].status	string	密钥状态（active/revoked）
items[].created_at_ms	int	创建时间

十二、获取密钥详情

按密钥 ID 查询密钥详细信息。

POST /v3/user-key/get

十三、请求参数

字段	类型	必选	说明
key_id	string	是	密钥 ID

十四、请求示例

十五、响应示例

{ "code":0, "message":"ok", "request_id":"req-7fd3b2dd", "data":{ "key_id":"key-abc123", "name":"dev-key", "status":"active", "created_at_ms":1758096000000, "updated_at_ms":1758182400000 }}

十六、响应 data

字段	类型	说明
key_id	string	密钥 ID
name	string	密钥名称
status	string	密钥状态
created_at_ms	int	创建时间
updated_at_ms	int	最后更新时间

十七、撤销密钥

撤销指定密钥，撤销后该密钥不再可用于鉴权。

POST /v3/user-key/revoke

十八、请求参数

字段	类型	必选	说明
key_id	string	是	待撤销的密钥 ID

十九、请求示例

20、响应示例

{ "code":0, "message":"ok", "request_id":"req-7fd3b2dd", "data":{ "revoked":true }}

21、响应 data

字段	类型	说明
revoked	bool	撤销是否成功

22、更新密钥

更新密钥的名称等属性。

POST /v3/user-key/update

23、请求参数

字段	类型	必选	说明
key_id	string	是	密钥 ID
name	string	否	更新后的密钥名称

24、请求示例

curl -i -X POST \\ -H 'Content-Type: application/json' \\ -H 'Authorization: Bearer *********************************' \\ -H "x-tdai-service-id: tdai-mem-xxxxxxxx" \\ https://memory.tdai.tencentyun.com/v3/user-key/update \\ -d '{"key_id":"key-abc123","name":"new-name"}'

25、响应示例

{ "code":0, "message":"ok", "request_id":"req-7fd3b2dd", "data":{ "key_id":"key-abc123", "updated_at_ms":1758268800000 }}

26、响应 data

字段	类型	说明
key_id	string	密钥 ID
updated_at_ms	int	最后更新时间

27、错误码

HTTP 状态码	错误信息	说明
400	request: Invalid input	请求参数不合法。
401	Missing or invalid Authorization header	Bearer API Key 缺失或格式不正确。
	Missing x-tdai-service-id header	请求头中未携带 x-tdai-service-id。
404	USER_KEY_NOT_FOUND	指定密钥不存在。
500	Internal error	服务内部错误，可有限重试。

腾讯云数据库 AI 服务 用户密钥管理（Metadata）