一時的な API キーの生成 - Alibaba Cloud Model Studio - Alibaba Cloud ドキュメントセンター

ブラウザやモバイルアプリなどの信頼されていない環境からモデルサービスを呼び出すには、安全なバックエンドサービスを使用して一時的な API キーを生成します。これにより、永続的な API キーが公開されるのを防ぎます。

重要

一時的な API キーは、その作成に使用された API キーからすべての権限を継承します。これには、特定のモデルやナレッジベースに対するアクセス制限も含まれます。

前提条件

キー管理 (Singapore)、キー管理 (Virginia)、キー管理 (Beijing)、またはキー管理 (China (Hong Kong)) ページで永続的な API キーを取得します。次に、そのキーを DASHSCOPE_API_KEY 環境変数として設定します。詳細については、「API キーを環境変数として設定する」をご参照ください。

リクエスト例

デフォルトでは、一時的な API キーは 60 秒間有効です。expire_in_seconds パラメーターを使用して、1 秒から 1,800 秒の範囲でカスタムの有効期間 (TTL) を設定します。

API キーはリージョンによって異なります。

次の例では、シンガポールリージョンのエンドポイントを使用します。WorkspaceId は、実際のワークスペース ID に置き換えてください。北京リージョンの場合は、URL を https://dashscope.aliyuncs.com/api/v1/tokens?expire_in_seconds=1800 に置き換えます。

# これは Singapore リージョンの URL です。`WorkspaceId` を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
curl -X POST "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v1/tokens?expire_in_seconds=1800" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY"

応答例

成功応答例

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

応答パラメーター

パラメーター	タイプ	説明	例
token	文字列	生成された一時的な API キー。	st-****
expires_at	数値	UNIX タイムスタンプ (秒単位) での失効時刻。	1744080369

エラー応答例

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

応答パラメーター

パラメーター	タイプ	説明	例
code	文字列	エラーコード。原因と解決策については、「エラーコード」をご参照ください。	InvalidApiKey
message	文字列	エラーメッセージ。	Invalid API-key provided.
request_id	文字列	リクエスト ID。	902fee3b-f7f0-9a8c-96a1-6b4ea25af114

よくある質問

Q: 一時的な API キーを手動で削除できますか?

A: いいえ。一時的な API キーは固定のライフサイクルを持ち、自動的に失効します。失効前に削除することはできません。