Certains modèles Model Studio (comme la génération d'images et de vidéos) utilisent une invocation asynchrone en raison de temps de traitement longs. Le flux de travail typique consiste à créer une tâche pour obtenir un ID, puis à interroger le résultat à l'aide de cet ID. Model Studio fournit des API de tâches polyvalentes pour interroger les résultats individuels, vérifier les statuts de plusieurs tâches par lot et annuler les tâches en file d'attente.
Prérequis
Vous pouvez appeler les API de tâches asynchrones via HTTP.
Avant d'appeler les API, obtenez et configurez une clé API, puis définissez la clé API comme variable d'environnement.
Interroger le résultat d'une tâche asynchrone
Description de l'API : Interroge le statut et le résultat d'une tâche en fonction de son task_id.
Limite de débit : 20 QPS par compte Alibaba Cloud (inclut tous les utilisateurs RAM).
Endpoint de requête
Paramètres de requête
Transmission du paramètre | Champ | Type | Obligatoire | Description | Exemple |
|---|---|---|---|---|---|
Header | Authorization | String | Oui | Clé API au format | Bearer sk-xxx |
Path | task_id | String | Oui | L'ID de la tâche à interroger. | a8532587-xxxx-xxxx-xxxx-0c46b17950d1 |
Paramètres de réponse
| Champ | Type | Description | Exemple |
|---|---|---|---|
| request_id | String | L'ID unique pour cette requête. | 7574ee8f-xxxx-xxxx-xxxx-11c33ab46e51 |
| output | Object |
| |
| output.task_id | String | L'ID de la tâche interrogée. | a8532587-xxxx-xxxx-xxxx-0c46b17950d1 |
| output.task_status | String | Le statut de la tâche.
| Statut de la tâche :
|
| output.submit_time | String | L'heure de soumission de la tâche. | 2023-12-20 21:36:31.896 |
| output.scheduled_time | String | L'heure de planification de la tâche (lorsqu'elle a commencé à s'exécuter). | 2023-12-20 21:36:39.009 |
| output.end_time | String | L'heure de fin de la tâche. | 2023-12-20 21:36:45.913 |
| output.code | String | Le code d'erreur (renvoyé uniquement lorsque la tâche échoue). | |
| output.message | String | Le message d'erreur (renvoyé uniquement lorsque la tâche échoue). | |
| output.task_metrics | Object | Métriques de la tâche, y compris les statistiques de statut des sous-tâches. | {"TOTAL": 4, // Nombre total de sous-tâches"SUCCEEDED": 3, // Nombre de sous-tâches réussies"FAILED": 1 // Nombre de sous-tâches ayant échoué} |
| usage | Object | Les informations de facturation pour cette requête (varient selon la tâche). | "usage": {"image_count": 1} |
Exemple de requête
$DASHSCOPE_API_KEY n'est pas définie comme variable d'environnement, remplacez-la par votre clé API réelle (format : Bearer sk-xxx).Exemple de réponse
Interroger le statut de plusieurs tâches asynchrones
Description de l'API : Interrogez plusieurs tâches asynchrones en utilisant diverses conditions. Vérifiez le statut de plusieurs tâches en une seule requête.
Limite de débit : 20 QPS par compte Alibaba Cloud (inclut tous les utilisateurs RAM).
Endpoint de la requête
Paramètres de la requête
| Transmission des paramètres | Champ | Type | Obligatoire | Description | Exemple |
|---|---|---|---|---|---|
| Header | Authorization | String | Oui | La clé API, au format Bearer sk-xxx. | Bearer sk-xxx |
| Params | task_id | String | Non | L'ID de la tâche à interroger. Spécifiez un task_id pour renvoyer uniquement le statut de cette tâche, ou omettez-le pour interroger plusieurs tâches. | a8532587-xxxx-xxxx-xxxx-0c46b17950d1 |
| start_time | String | Non | Heure de début de la requête au format YYYYMMDDhhmmss. Par défaut, 24 heures avant end_time (si end_time est spécifié), ou les dernières 24 heures (si aucune heure n'est spécifiée). Plage maximale : 24 heures. | 20230420193058 représente 19:30:58 le 20 avril 2023. | |
| end_time | String | Non | Heure de fin de la requête au format YYYYMMDDhhmmss. Par défaut, 24 heures après start_time (si start_time est spécifié). Plage maximale : 24 heures. | ||
| model_name | String | Non | Le nom du modèle. | wanx-v1 | |
| status | String | Non | Le statut de la tâche :
| ||
| page_no | Integer | Non | Le numéro de page des résultats à renvoyer. Valeur par défaut : 1. | ||
| page_size | Integer | Non | Le nombre d'entrées par page. Valeur par défaut : 10. |
Paramètres de réponse
| Champ | Type | Description | Exemple |
|---|---|---|---|
| request_id | String | L'ID unique de cette requête. | 7574ee8f-xxxx-xxxx-xxxx-11c33ab46e51 |
| data | Array | Une liste des résultats de la requête. | |
| data[].api_key_id | String | L'ID de la clé API. | |
| data[].caller_parent_id | String | L'ID du compte Alibaba Cloud. | |
| data[].caller_uid | String | L'ID du compte Alibaba Cloud. | |
| data[].gmt_create | Long | L'heure de création de la tâche (millisecondes depuis l'époque Unix). | |
| data[].start_time | Long | L'heure de début de la tâche, en millisecondes depuis l'époque Unix. | |
| data[].end_time | Long | L'heure de fin de la tâche, en millisecondes depuis l'époque Unix. | |
| data[].region | String | La région. Exemple : cn-hangzhou | |
| data[].request_id | String | L'ID de la requête pour la soumission de la tâche. | |
| data[].status | String | Le statut de la tâche :
| |
| data[].task_id | String | L'ID de la tâche. | |
| data[].user_api_unique_key | String | Une clé API unique générée à partir des paramètres d'API du modèle lors de la soumission de la tâche. | |
| data[].model_name | String | Le nom du modèle. | |
| page_no | Integer | Le numéro de page actuel. | "page_no": 1 |
| page_size | Integer | Le nombre d'entrées par page. | "page_size": 10 |
| total_page | Integer | Le nombre total de pages. | "total_page": 4 |
| total | Integer | Le nombre total d'entrées. | "total": 39 |
| code | String | Le code d'erreur renvoyé en cas d'échec de l'appel. | "code": "Throttling.RateQuota" |
| message | String | Le message d'erreur renvoyé en cas d'échec de l'appel. | "message": "Requests rate limit exceeded, please try again later." |
Exemple de requête
Exemple de réponse
Annuler une tâche asynchrone
Description de l'API : Annule une tâche asynchrone. Seules les tâches dont le statut est PENDING (en file d'attente, non démarrées) peuvent être annulées.
Limite de débit : 20 QPS par compte Alibaba Cloud (inclut tous les utilisateurs RAM).
Endpoint de requête
Paramètres de requête
Passage des paramètres | Champ | Type | Obligatoire | Description | Exemple |
|---|---|---|---|---|---|
Header | Authorization | String | Oui | La clé API, au format Bearer sk-xxx. | Bearer sk-xxx |
Path | task_id | String | Oui | L'ID de la tâche à annuler. | a8532587-xxxx-xxxx-xxxx-0c46b17950d1 |
Paramètres de réponse
Une demande d'annulation réussie renvoie l'ID de la requête sous forme de chaîne JSON brute dans le corps de la réponse. La réponse de succès ne contient aucun champ d'objet JSON.
Pour les réponses d'erreur, les champs suivants sont renvoyés :
Champ | Type | Description | Exemple |
|---|---|---|---|
code | String | Le code d'erreur renvoyé en cas d'échec de l'appel. |
|
message | String | Le message d'erreur renvoyé en cas d'échec de l'appel. |
|
Exemple de requête
Exemple de réponse
Codes d'erreur
Code d'état HTTP | Code d'erreur | Message d'erreur | Description |
|---|---|---|---|
400 | UnsupportedOperation | Échec de l'annulation de la tâche. Vérifiez que la tâche est bien au statut PENDING. | L'annulation de la tâche a échoué. Seules les tâches dont le statut est |