產生臨時API Key
更新時間:
Copy as 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] 秒。
各地區的API Key 不同。
以下樣本使用新加坡地區的 Endpoint。如需使用北京地區,請將URL替換為:https://dashscope.aliyuncs.com/api/v1/tokens?expire_in_seconds=1800
curl -X POST "https://dashscope-intl.aliyuncs.com/api/v1/tokens?expire_in_seconds=1800" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY"
響應樣本
正常響應樣本
{
"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 具有固定的生命週期,到期後自動失效,無法提前刪除。
该文章对您有帮助吗?