OpenAPI integration example - Create an IMM project - Intelligent Media Management

Cree un proyecto de Intelligent Media Management (IMM) mediante la llamada a la API CreateProject con el SDK de Python.

Consulte la documentación de la API

En API overview, busque la operación CreateProject y revise sus parámetros y permisos obligatorios.

Identidad y permisos

Identidad

Esta operación de API se puede invocar con una cuenta de Alibaba Cloud, un usuario de RAM o un rol de RAM. Las diferencias entre identidades se explican en Identity, credential, and authorization. Este ejemplo utiliza un usuario de RAM. En la consola de RAM, cree un usuario de RAM con acceso exclusivo por API y registre el par de AccessKey. Create a RAM user.

Autorización

Vaya a Users. En la columna Actions del usuario de RAM correspondiente, haga clic en Add Permissions.
En el panel Add Permissions, seleccione AliyunIMMFullAccess y AliyunSTSAssumeRoleAccess.
Nota
- AliyunIMMFullAccess: otorga permisos de administración total sobre IMM. Configure a service role for a project.
- Para directivas personalizadas, consulte Configure permissions for RAM users.
Haga clic en Grant permissions.

Credencial de acceso

Credencial de acceso temporal: utilice credenciales temporales en escenarios que requieran mayor seguridad, como el acceso temporal de aplicaciones. Estas caducan automáticamente, lo que reduce el riesgo de filtración, y admiten un control de permisos detallado. Configure access credentials (Go SDK V1).
Credencial de acceso a largo plazo: evite las credenciales a largo plazo siempre que sea posible y use credenciales temporales en su lugar. Si necesita credenciales a largo plazo por comodidad, rótelas cada tres meses. Elimine o deshabilite de inmediato cualquier credencial filtrada o sin uso. Configure access credentials (Go SDK V1).

AccessKey a largo plazo

Se genera un AccessKey al crear un usuario de RAM.
Haga clic en el nombre del usuario de RAM para abrir la página de detalles. En la pestaña Authentication, haga clic en Create AccessKey. Create AccessKey.

Credencial temporal de STS

Importante You can call this operation only as a RAM user or by assuming a RAM role, not with an Alibaba Cloud account.

Cree un usuario de RAM.

Create a RAM user.
Otorgue al usuario de RAM el permiso AliyunSTSAssumeRoleAccess.

Grant permissions to a RAM user.
Con el usuario de RAM, invoque la operación AssumeRole de Security Token Service (STS) para obtener una credencial de acceso temporal.

AssumeRole.

Nota

Using an STS token for API calls is more secure than using an AccessKey because it protects your long-term AccessKey from exposure. Si realiza varias llamadas temporales a IMM, actualice el token de STS manualmente.

Llame a la API

Este ejemplo utiliza el SDK de Python. Los SDK de otros lenguajes siguen un patrón similar. .

Prepare el entorno de Python

Descargue e instale Python 3.

Nota

Para comprobar su versión de Python, abra una terminal e introduzca python --version.

Configure las variables de entorno de AccessKey

Este ejemplo utiliza las variables de entorno ALIBABA_CLOUD_ACCESS_KEY_ID y ALIBABA_CLOUD_ACCESS_KEY_SECRET. Puede usar nombres de variable distintos, como OSS_ACCESS_KEY_ID y OSS_ACCESS_KEY_SECRET.

Importante

El par de AccessKey de una cuenta de Alibaba Cloud tiene permisos sobre todas las operaciones de API. Se recomienda utilizar el par de AccessKey de un usuario de RAM para invocar operaciones de API o realizar tareas habituales de operación y mantenimiento.

Establezca un AccessKey de Alibaba Cloud en las variables de entorno de Linux y macOS

Esta sección toma como ejemplo las variables de entorno ALIBABA_CLOUD_ACCESS_KEY_ID y ALIBABA_CLOUD_ACCESS_KEY_SECRET. Puede sustituir los nombres de las variables según sus necesidades; por ejemplo, OSS_ACCESS_KEY_ID y OSS_ACCESS_KEY_SECRET.

Configure las variables de entorno con el comando export:

Importante

Una variable de entorno temporal establecida con el comando export solo es válida para la sesión actual. La variable se elimina cuando finaliza la sesión. Para conservarla de forma permanente, agregue el comando export al archivo de configuración de inicio de su sistema operativo.

Configure el AccessKey ID y presione Entrar.

# Replace yourAccessKeyID with your AccessKey ID.
export ALIBABA_CLOUD_ACCESS_KEY_ID=yourAccessKeyID

Configure el AccessKey secret y presione Entrar.

# Replace yourAccessKeySecret with your AccessKey secret.
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=yourAccessKeySecret

Compruebe la configuración.

Ejecute el comando echo $ALIBABA_CLOUD_ACCESS_KEY_ID. Si el comando devuelve el AccessKey ID correcto, la configuración fue exitosa.

Establezca un AccessKey de Alibaba Cloud en las variables de entorno de Windows

Uso de la interfaz gráfica de usuario (GUI)

Procedimiento

A continuación se describe cómo establecer variables de entorno mediante la GUI en Windows 10.

En el escritorio, haga clic con el botón derecho en This PC y elija Properties > Advanced system settings > Environment Variables > New dentro de System variables o User variables. Después, complete la configuración.

Variable	Valor de ejemplo
AccessKey ID	Nombre de la variable: ALIBABA_CLOUD_ACCESS_KEY_ID Valor de la variable: yourAccessKeyID
AccessKey secret	Nombre de la variable: ALIBABA_CLOUD_ACCESS_KEY_SECRET Valor de la variable: yourAccessKeySecret

Prueba de la configuración

Haga clic en Start (o use el atajo de teclado Win+R), luego en Run, introduzca cmd y haga clic en OK (o presione Entrar) para abrir el símbolo del sistema. Ejecute los comandos echo %ALIBABA_CLOUD_ACCESS_KEY_ID% y echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%. Si los comandos devuelven el AccessKey correcto, la configuración fue exitosa.

Uso del símbolo del sistema (CMD)

Procedimiento

Abra el símbolo del sistema como administrador y ejecute los siguientes comandos para agregar nuevas variables de entorno al sistema.
```
setx ALIBABA_CLOUD_ACCESS_KEY_ID yourAccessKeyID /M
setx ALIBABA_CLOUD_ACCESS_KEY_SECRET yourAccessKeySecret /M
```
El parámetro /M indica que se trata de una variable de entorno del sistema. Puede omitir este parámetro cuando establezca una variable de entorno de usuario.
Prueba de la configuración

Haga clic en Start (o use el atajo de teclado Win+R), luego en Run, introduzca cmd y haga clic en OK (o presione Entrar) para abrir el símbolo del sistema. Ejecute los comandos echo %ALIBABA_CLOUD_ACCESS_KEY_ID% y echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%. Si los comandos devuelven el AccessKey correcto, la configuración fue exitosa.

Uso de Windows PowerShell

En PowerShell, puede establecer nuevas variables de entorno válidas para todas las sesiones nuevas:

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'yourAccessKeyID', [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'yourAccessKeySecret', [System.EnvironmentVariableTarget]::User)

Para establecer variables de entorno para todos los usuarios, necesita permisos de administrador:

[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_ID', 'yourAccessKeyID', [System.EnvironmentVariableTarget]::Machine)
[System.Environment]::SetEnvironmentVariable('ALIBABA_CLOUD_ACCESS_KEY_SECRET', 'yourAccessKeySecret', [System.EnvironmentVariableTarget]::Machine)

También puede establecer variables de entorno temporales, válidas únicamente para la sesión actual:

$env:ALIBABA_CLOUD_ACCESS_KEY_ID = "yourAccessKeyID"
$env:ALIBABA_CLOUD_ACCESS_KEY_SECRET = "yourAccessKeySecret"

En PowerShell, ejecute los comandos Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_ID y Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_SECRET. Si los comandos devuelven el AccessKey correcto, la configuración fue exitosa.

Importante

Después de configurar las variables de entorno, es posible que deba reiniciar sus herramientas de desarrollo, como los entornos de desarrollo integrados (IDE), o los servicios para que la nueva configuración surta efecto.

Configure las variables de entorno del token de STS

Mac OS X/Linux/Unix

export IMM_ACCESS_KEY_ID=<ALIBABA_CLOUD_ACCESS_KEY_ID>
export IMM_ACCESS_KEY_SECRET=<ALIBABA_CLOUD_ACCESS_KEY_SECRET>
export IMM_SESSION_TOKEN=<ALIBABA_CLOUD_SECURITY_TOKEN>

Windows

set IMM_ACCESS_KEY_ID <ALIBABA_CLOUD_ACCESS_KEY_ID>
set IMM_ACCESS_KEY_SECRET <ALIBABA_CLOUD_ACCESS_KEY_SECRET>
set IMM_SESSION_TOKEN <ALIBABA_CLOUD_SECURITY_TOKEN>

Descargue el código de ejemplo e instale las dependencias

pip install alibabacloud_credentials

On the Parameter Configuration tab, set the required parameters, such as projectName.

pip install alibabacloud_tea_console

Decompress the sample code package locally and go to the alibabacloud_sample directory.

Ejecute el código de ejemplo

Ejecute el siguiente comando.

python sample.py

Se obtiene el siguiente resultado.

{
    "headers":{
        "date":"Thu, 10 Aug 2023 06:34:51 GMT",
        "content-type":"application/json;charset=utf-8",
        "content-length":"602",
        "connection":"keep-alive",
        "keep-alive":"timeout=25",
        "access-control-allow-origin":"*",
        "access-control-expose-headers":"*",
        "x-acs-request-id":"2C489857-69E6-5974-B963-A7DF99EFFF43",
        "x-acs-trace-id":"eccc35df82a086e7bb4f4fe778f****",
        "etag":"6HYADxT6iVDNgQUq+wGO****"
    },
    "statusCode":200,
    "body":{
        "Project":{
            "CreateTime":"2023-08-10T14:34:51.586696893+08:00",
            "DatasetCount":0,
            "DatasetMaxBindCount":10,
            "DatasetMaxEntityCount":10000000000,
            "DatasetMaxFileCount":100000000,
            "DatasetMaxRelationCount":100000000000,
            "DatasetMaxTotalFileSize":90000000000000000,
            "Description":"",
            "EngineConcurrency":200,
            "FileCount":0,
            "ProjectMaxDatasetCount":1000000000,
            "ProjectName":"testproject",
            "ProjectQueriesPerSecond":200,
            "ServiceRole":"AliyunIMMDefaultRole",
            "TemplateId":"Official:DefaultEmptyId",
            "TotalFileSize":0,
            "UpdateTime":"2023-08-10T14:34:51.586696977+08:00"
        },
        "RequestId":"2C489857-69E6-5974-B963-A7DF99EFFF43"
    }
}