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

Créez un projet Intelligent Media Management (IMM) en appelant l'opération API CreateProject avec le SDK Python.

Consulter la documentation de l'API

Dans la Vue d'ensemble des API, localisez l'opération CreateProject et examinez ses paramètres requis ainsi que les autorisations nécessaires.

Identité et autorisations

Identité

Vous pouvez appeler cette opération API avec un compte Alibaba Cloud, un utilisateur RAM ou un rôle RAM. Les différences entre ces identités sont expliquées dans la rubrique Identité, identifiants et autorisation. Cet exemple utilise un utilisateur RAM. Dans la console RAM, créez un utilisateur RAM disposant uniquement d'un accès API et notez la paire AccessKey. Consultez la rubrique Créer un utilisateur RAM.

Autorisation

Accédez à la page Utilisateurs, puis cliquez sur Add Permissions dans la colonne Actions correspondant à l'utilisateur RAM cible.
Dans le panneau Add Permissions, sélectionnez les stratégies AliyunIMMFullAccess et AliyunSTSAssumeRoleAccess.
Remarque
- AliyunIMMFullAccess : accorde des autorisations de gestion complètes sur IMM. Pour plus d'informations, consultez la rubrique Configurer un rôle de service pour un projet.
- Pour les stratégies personnalisées, consultez la rubrique Configurer les autorisations pour les utilisateurs RAM.
Cliquez sur Grant permissions.

Identifiant d'accès

Identifiant d'accès temporaire : utilisez des identifiants temporaires pour les scénarios nécessitant une sécurité accrue, tels que l'accès temporaire aux applications. Ils expirent automatiquement, ce qui réduit les risques de fuite, et permettent un contrôle fin des autorisations. Pour plus d'informations, consultez la section Configurer les identifiants d'accès (SDK Go V1).
Identifiant d'accès à long terme : évitez autant que possible les identifiants à long terme. Privilégiez les identifiants temporaires. Si vous devez utiliser des identifiants à long terme par souci de commodité, faites-les tourner tous les trois mois. Supprimez ou désactivez immédiatement les identifiants compromis ou inutilisés. Pour plus d'informations, consultez la section Configurer les identifiants d'accès (SDK Go V1).

AccessKey à long terme

Une AccessKey peut être générée lors de la création d'un utilisateur RAM.
Cliquez sur le nom de l'utilisateur RAM pour ouvrir sa page de détails. Sous l'onglet Authentication, cliquez sur Create AccessKey. Pour plus d'informations, consultez la rubrique Créer une AccessKey.

Identifiant temporaire STS

Important

Vous ne pouvez appeler cette opération qu'en tant qu'utilisateur RAM ou en endossant un rôle RAM, et non avec un compte Alibaba Cloud.

Créez un utilisateur RAM.

Pour plus d'informations, consultez la rubrique Créer un utilisateur RAM.
Accordez à l'utilisateur RAM l'autorisation AliyunSTSAssumeRoleAccess.

Pour plus d'informations, consultez la rubrique Accorder des autorisations à un utilisateur RAM.
En tant qu'utilisateur RAM, appelez l'opération AssumeRole du Security Token Service (STS) pour obtenir un identifiant d'accès temporaire.

Pour plus d'informations, consultez la rubrique AssumeRole.

Remarque

L'utilisation d'un jeton STS pour les appels API est plus sécurisée que l'utilisation d'une AccessKey, car elle protège votre AccessKey à long terme contre toute exposition. Si vous effectuez plusieurs appels temporaires vers IMM, actualisez manuellement le jeton STS.

Appeler l'API

Cet exemple utilise le SDK Python. Les SDK pour d'autres langages suivent un schéma similaire. .

Préparer l'environnement Python

Téléchargez et installez Python 3.

Remarque

Pour vérifier votre version de Python, ouvrez un terminal et saisissez python --version.

Configurer les variables d'environnement AccessKey

Cet exemple utilise les variables d'environnement ALIBABA_CLOUD_ACCESS_KEY_ID et ALIBABA_CLOUD_ACCESS_KEY_SECRET. Vous pouvez utiliser d'autres noms de variables, tels que OSS_ACCESS_KEY_ID et OSS_ACCESS_KEY_SECRET.

Important

La paire AccessKey d'un compte Alibaba Cloud dispose d'autorisations sur toutes les opérations API. Utilisez la paire AccessKey d'un utilisateur RAM pour appeler des opérations API ou effectuer des tâches courantes d'exploitation et de maintenance (O&M). Ne stockez pas directement les identifiants dans le code de votre application et ne les validez pas dans le contrôle de version.

Définir une AccessKey Alibaba Cloud dans les variables d'environnement sous Linux et macOS

Cette section utilise les variables d'environnement ALIBABA_CLOUD_ACCESS_KEY_ID et ALIBABA_CLOUD_ACCESS_KEY_SECRET à titre d'exemple. Vous pouvez remplacer les noms de variables selon vos besoins, par exemple OSS_ACCESS_KEY_ID et OSS_ACCESS_KEY_SECRET.

Configurer les variables d'environnement à l'aide de la commande export

Important

Une variable d'environnement temporaire définie à l'aide de la commande export n'est valable que pour la session en cours. La variable est effacée à la fin de la session. Pour une conservation à long terme (LTR), ajoutez la commande export au fichier de configuration de démarrage de votre système d'exploitation.

Configurez l'ID AccessKey et appuyez sur Entrée.

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

Configurez le secret AccessKey et appuyez sur Entrée.

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

Vérifiez la configuration.

Exécutez la commande echo $ALIBABA_CLOUD_ACCESS_KEY_ID. Si la commande renvoie l'ID AccessKey correct, la configuration a réussi.

Définir une AccessKey Alibaba Cloud dans les variables d'environnement sous Windows

Utiliser l'interface graphique (GUI)

Procédure

Les étapes suivantes décrivent comment définir les variables d'environnement à l'aide de l'interface graphique sous Windows 10.

Sur votre bureau, faites un clic droit sur Ce PC et choisissez Propriétés > Paramètres système avancés > Variables d'environnement > Nouveau sous Variables système ou Variables utilisateur. Ensuite, terminez la configuration.

Variable	Valeur d'exemple
ID AccessKey	Nom de la variable : ALIBABA_CLOUD_ACCESS_KEY_ID Valeur de la variable : yourAccessKeyID
Secret AccessKey	Nom de la variable : ALIBABA_CLOUD_ACCESS_KEY_SECRET Valeur de la variable : yourAccessKeySecret

Tester la configuration

Cliquez sur Start (ou utilisez le raccourci clavier Win+R), cliquez sur Run, saisissez cmd, puis cliquez sur OK (ou appuyez sur Entrée) pour ouvrir l'invite de commandes. Exécutez les commandes echo %ALIBABA_CLOUD_ACCESS_KEY_ID% et echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%. Si les commandes renvoient l'AccessKey correcte, la configuration a réussi.

Utiliser l'invite de commandes (CMD)

Procédure

Ouvrez l'invite de commandes en tant qu'administrateur et exécutez les commandes suivantes pour ajouter de nouvelles variables d'environnement au système.
```
setx ALIBABA_CLOUD_ACCESS_KEY_ID yourAccessKeyID /M
setx ALIBABA_CLOUD_ACCESS_KEY_SECRET yourAccessKeySecret /M
```
Le paramètre /M indique une variable d'environnement système. Vous pouvez omettre ce paramètre lorsque vous définissez une variable d'environnement utilisateur.
Tester la configuration

Cliquez sur Start (ou utilisez le raccourci clavier Win+R), cliquez sur Run, saisissez cmd, puis cliquez sur OK (ou appuyez sur Entrée) pour ouvrir l'invite de commandes. Exécutez les commandes echo %ALIBABA_CLOUD_ACCESS_KEY_ID% et echo %ALIBABA_CLOUD_ACCESS_KEY_SECRET%. Si les commandes renvoient l'AccessKey correcte, la configuration a réussi.

Utiliser Windows PowerShell

Dans PowerShell, vous pouvez définir de nouvelles variables d'environnement valables pour toutes les nouvelles sessions :

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

Pour définir des variables d'environnement pour tous les utilisateurs, vous devez disposer d'autorisations d'administrateur :

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

Vous pouvez définir des variables d'environnement temporaires valables uniquement pour la session en cours :

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

Dans PowerShell, exécutez les commandes Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_ID et Get-ChildItem env:ALIBABA_CLOUD_ACCESS_KEY_SECRET. Si les commandes renvoient l'AccessKey correcte, la configuration a réussi.

Important

Après avoir configuré les variables d'environnement, vous devrez peut-être redémarrer vos outils de développement, tels que les environnements de développement intégrés (IDE), ou les services pour que les nouveaux paramètres prennent effet.

Configurer les variables d'environnement du jeton 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>

Télécharger l'exemple de code et installer les dépendances

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.

Exécuter l'exemple de code

Exécutez la commande suivante.

python sample.py

Le résultat suivant s'affiche.

{
    "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"
    }
}