Alibaba Cloud Model Studio:Obtener una clave de API

Antes de utilizar modelos o aplicaciones en Alibaba Cloud Model Studio, debe obtener una clave de API para la autenticación.

Este tema describe la clave de API de pago por uso para Model Studio. Si está utilizando un Token Plan o Coding Plan, use la clave de API dedicada correspondiente (comienza con sk-sp-). Para obtener más información, consulte Clave de API de Token Plan y Clave de API de Coding Plan.

Creación de una clave API

Este procedimiento debe ser realizado por una cuenta de Alibaba Cloud o un usuario RAM con permisos de página de administrator o API-Key .

Configurar la clave de API como variable de entorno

Recomendamos configurar su clave de API como una variable de entorno. Esto le ayuda a evitar codificar la clave directamente en su código fuente, reduciendo el riesgo de exposición accidental.

# Replace YOUR_DASHSCOPE_API_KEY with your DashScope API key
echo "export DASHSCOPE_API_KEY='YOUR_DASHSCOPE_API_KEY'" >> ~/.bashrc

nano ~/.bashrc

# Replace YOUR_DASHSCOPE_API_KEY with your DashScope API key
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

source ~/.bashrc

echo $DASHSCOPE_API_KEY

# Replace YOUR_DASHSCOPE_API_KEY with your DashScope API key
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

echo $DASHSCOPE_API_KEY

echo $SHELL

# Replace YOUR_DASHSCOPE_API_KEY with your DashScope API key
export DASHSCOPE_API_KEY="YOUR_DASHSCOPE_API_KEY"

echo $DASHSCOPE_API_KEY

echo %DASHSCOPE_API_KEY%

Microsoft Windows [Version 10.0.19045.5371]
(c) Microsoft Corporation. All rights reserved.
C:\Windows\system32>echo %DASHSCOPE_API_KEY%
sk-ee16697?fe4
C:\Windows\system32>

echo $env:DASHSCOPE_API_KEY

Windows PowerShell
Copyright (C) Microsoft Corporation. All rights reserved.
Try the new cross-platform PowerShell https://aka.ms/pscore6
PS C:\Windows\system32> echo $env:DASHSCOPE_API_KEY
sk-ee166797fe40xxx
PS C:\Windows\system32>

REM Replace YOUR_DASHSCOPE_API_KEY with your DashScope API key
setx DASHSCOPE_API_KEY "YOUR_DASHSCOPE_API_KEY"

echo %DASHSCOPE_API_KEY%

REM Replace YOUR_DASHSCOPE_API_KEY with your DashScope API key
set DASHSCOPE_API_KEY=YOUR_DASHSCOPE_API_KEY

echo %DASHSCOPE_API_KEY%

# Replace YOUR_DASHSCOPE_API_KEY with your DashScope API key
[Environment]::SetEnvironmentVariable("DASHSCOPE_API_KEY", "YOUR_DASHSCOPE_API_KEY", [EnvironmentVariableTarget]::User)

echo $env:DASHSCOPE_API_KEY

# Replace YOUR_DASHSCOPE_API_KEY with your DashScope API key
$env:DASHSCOPE_API_KEY = "YOUR_DASHSCOPE_API_KEY"

echo $env:DASHSCOPE_API_KEY

Uso de una clave API

• Método 1: Llamar a modelos desdeherramientas de terceros

  Guías de configuración para herramientas comunes: Chatbox, Cline, Claude Code, Dify, OpenClaw, Postman y Qwen Code.

• Método 2: Invocar modelos mediante código

  Cuando llama a la API de Qwen por primera vez mediante código, recomendamos que configure la clave de API como una variable de entorno para evitar codificarla directamente en su código, lo cual reduce el riesgo de filtraciones.

Cuando llama a un modelo desde código o una herramienta de terceros, además de la clave de API, debe especificar un endpoint de servicio (el API Host que se muestra en el cuadro de diálogo de creación exitosa, que corresponde al base_url en su SDK o solicitud HTTP). Model Studio proporciona interfaces de protocolo compatibles con OpenAI y compatibles con Anthropic. El base_url difiere entre los dos protocolos y varía según la región. Consulte la documentación del protocolo que utiliza:

• Protocolo compatible con OpenAI: Compatible con OpenAI - Chat
• Protocolo compatible con Anthropic: Mensajes compatibles con Anthropic

No exponga su clave API.

Actualización de seguridad de claves de API

Model Studio ha actualizado el mecanismo de generación y almacenamiento de claves de API de pago por uso para mejorar la seguridad (excepto en la región EE. UU. (Virginia)). Las claves de API creadas antes de la actualización que comienzan con sk- siguen siendo totalmente funcionales y no se ven afectadas. Todas las claves de API creadas después de la actualización comienzan con sk-ws.

La siguiente tabla describe las principales diferencias entre las claves de API creadas antes y después de la actualización.

Gestionar claves de API a través de la API

Además de las operaciones de la consola, Alibaba Cloud Model Studio proporciona operaciones de OpenAPI que le permiten crear, consultar, editar, eliminar, habilitar, deshabilitar y restablecer claves de API mediante programación, para que pueda integrar la gestión de claves de API en flujos de trabajo automatizados. La llamada a las siguientes operaciones requiere autenticación de firma con la AccessKey de su cuenta de Alibaba Cloud (no la propia clave de API) y los permisos de RAM correspondientes. Puede depurar cada operación en línea en el portal para desarrolladores de OpenAPI o llamarla a través de un SDK de Alibaba Cloud.

Permisos de clave API

Los permisos de una clave de API están determinados completamente por su espacio de trabajo. Todas las claves de API dentro del mismo espacio de trabajo tienen permisos idénticos. No necesita crear diferentes claves de API para distintos modelos, como modelos de texto a texto, de texto a imagen o de síntesis de voz.

• Clave de API en el espacio de trabajo predeterminado: Puede llamar a todos los modelos estándar y a cualquier aplicación dentro del espacio de trabajo predeterminado.
• Clave de API en un subespacio de trabajo: Puede llamar a modelos estándar autorizados para el subespacio de trabajo y a cualquier aplicación dentro de ese subespacio de trabajo.

Llamada a unmodelo ajustado: Después de ajustar e implementar un modelo en Alibaba Cloud Model Studio, solo una clave de API del espacio de trabajo del modelo puede llamarlo. No se requiere autorización por separado.

Cuando Create API Key o hace clic en Edit para una clave de API existente, puede cambiar los Permissions a Personalizado y configurar lo siguiente:

• Lista blanca de direcciones IP: Permite que solo las direcciones IP en la lista blanca usen la clave de API para realizar llamadas (admite direcciones IPv4 y bloques CIDR; IPv6 solo es compatible en la región China (Beijing), y la región EE. UU. (Virginia) solo admite IPv4).
• Ámbito de acceso: Seleccione los modelos o aplicaciones específicos a los que esta clave de API puede acceder. La clave no puede llamar a recursos no seleccionados. Puede seleccionar hasta 30 modelos.

Validez de la clave API

Las claves API no caducan. Permanecen válidas hasta que las elimine manualmente.

Para otorgar acceso temporal a aplicaciones o usuarios de terceros, o para controlar estrictamente operaciones de alto riesgo como acceder o eliminar datos sensibles, puede generar una clave de API temporal (válida por hasta 1800 segundos). Esto evita exponer una clave de API a largo plazo y reduce el riesgo de filtraciones.

Códigos de error

Si una llamada al modelo falla y devuelve un mensaje de error, consulte Códigos de error para solucionar el problema.

FAQ

R: Cada cuenta de Alibaba Cloud puede crear hasta 10 espacios de trabajo (incluido el espacio de trabajo predeterminado), y cada espacio de trabajo puede tener hasta 20 claves de API.

R: No. Después de deshabilitar o eliminar un usuario RAM en la consola RAM, todas las claves de API creadas por ese usuario dejan de ser válidas y ya no se pueden usar para llamadas a modelos.

P: Usé elechocomando y confirmé que la variable de entorno estaba configurada correctamente. ¿Por qué mi código sigue indicando que no se encuentra la clave de API?

R: Esto puede ocurrir por las siguientes razones:

• Escenario 1: Se configuró una variable de entorno temporal. Una variable temporal solo es válida dentro de la sesión de terminal actual y no afecta a los IDE en ejecución u otras aplicaciones. Consulte las instrucciones en este tema para configurar una variable de entorno permanente.

• Escenario 2: El IDE, la herramienta de línea de comandos o la aplicación no se reiniciaron.

  • Debe reiniciar su IDE (como VS Code) o terminal para cargar las nuevas variables de entorno.
  • Si configura la variable de entorno después de implementar una aplicación, debe reiniciar el servicio de la aplicación para volver a cargar las variables de entorno.

• Escenario 3: La variable falta en un archivo de configuración del servicio. Si su aplicación es iniciada por un administrador de servicios, como systemd o supervisord, es posible que deba agregar la variable de entorno al archivo de configuración del administrador de servicios.

• Escenario 4: Uso delsudocomando. Si usa sudo python xx.py para ejecutar el script, es posible que las variables de entorno del usuario actual no se hereden. Esto se debe a que sudo no hereda todas las variables de entorno de forma predeterminada. Puede usar el comando sudo -E python xx.py, donde el parámetro -E asegura que las variables de entorno se pasen. Si tiene permiso para ejecutar el script, puede ejecutar python xx.py directamente.