生成临时API Key

更新时间:
复制为 MD 格式

在浏览器、移动 App 等不可信环境中调用模型服务时,通过安全的后端服务生成临时API Key,避免永久API Key 泄露。

重要

临时API Key 继承生成它的API Key 所拥有的全部权限,包括对特定模型或知识库的访问限制。

前提条件

密钥管理(北京)密钥管理(新加坡)密钥管理(弗吉尼亚)页面创建永久API Key,并将其配置为环境变量 DASHSCOPE_API_KEY。配置方法请参见配置API Key 到环境变量

请求示例

临时API Key 默认有效期为 60 秒,支持通过 expire_in_seconds 参数设置有效期(TTL),范围为 [1, 1800] 秒。

curl -X POST "https://dashscope.aliyuncs.com/api/v1/tokens?expire_in_seconds=1800" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" 
各地域的API Key 不同。
以下示例使用新加坡地域的 Endpoint。如需使用北京地域,请将URL替换为:https://dashscope.aliyuncs.com/api/v1/tokens?expire_in_seconds=1800

响应示例

正常响应示例

{  
    "token":"st-****",
    "expires_at":1744080369
}

响应参数

参数名称

参数类型

说明

示例

token

String

生成的临时API Key。

st-****

expires_at

Number

过期时间,UNIX 时间戳,单位为秒。

1744080369

错误响应示例

{  
    "code":"InvalidApiKey",
    "message":"Invalid API-key provided.",
    "request_id":"902fee3b-f7f0-9a8c-96a1-6b4ea25af114"
}

响应参数

参数名称

参数类型

说明

示例

code

String

错误码。更多错误原因及解决方法,请前往错误信息页面查询。

InvalidApiKey:无效API Key

message

String

错误信息。

Invalid API-key provided.

request_id

String

请求 ID。

902fee3b-f7f0-9a8c-96a1-6b4ea25af114

常见问题

问:能否手动删除已创建的临时API Key?

答:不能。临时API Key 具有固定的生命周期,到期后自动失效,无法提前删除。