Interroger la progression de la construction d'un Adventure World. L'API retourne l'ID de World chiffré, le statut de construction et l'URL de la première image ; le client interroge jusqu'à ce que le World passe à ready.
Scope
Interroger la progression de la construction d'un Adventure World. Avant d'appeler, confirmez les points suivants :
- Authentification : La primary API Key n'est pas requise ; soit la clé API principale, soit une clé API temporaire peut appeler ce point de terminaison. Pour savoir comment les obtenir, voir Obtain authentication credentials.
- Prérequis : Interroger avec l'
encryptedWorldIdretourné par Create World. Vous pouvez commencer à interroger à partir de l'étatgenerating. - Appelant : Votre serveur ou votre client peut l'appeler.
Requête HTTP
- Singapore
- Chine (Pékin)
- États-Unis (Virginie)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/build-statusRemplacez {WorkspaceId} par votre véritable ID d'espace de travail.Paramètres de la requête |
|
Authorization string (Requis)Authentification par clé API. La clé API principale n'est pas requise ; la clé principale ou une clé API temporaire peut l'appeler.
| |
Paramètres de requête | |
encryptedWorldId string (Requis)L'ID de World chiffré retourné par Create World. Il est chiffré par le serveur ; vous n'avez pas besoin de le déchiffrer. |
Paramètres de réponse |
|
code integerCode de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur. | |
message stringMessage d'erreur. null en cas de succès. | |
data objectDonnées de réponse. null en cas d'échec.
Propriétés encryptedWorldId stringID chiffré du World.status stringStatut de la construction :
stringURL de la première image du World ; null lorsqu'elle n'est pas encore générée ou lorsque la construction a échoué.name stringNom du World. Retourné uniquement lorsque status=ready.mode integerToujours 1 pour Adventure. Retourné uniquement lorsque status=ready. |
États préalables et notes d'appel
- Sonder toutes les 3–5 secondes jusqu'à ce que
statussoitreadyoufailed. - Seul un World
readypeut échanger contre un identifiant de travel et entrer dans la salle. - Lorsqu'une image URL échoue à la validation après un stockage asynchrone, le World peut passer de
generatingàfailed. - Ce point de terminaison ne retourne pas
aspectRatio; lorsque vous avez besoin de métadonnées de création telles queperspectiveouuploadMode, appelez Query World Detail.
Codes d'erreur
Si l'appel du modèle échoue et renvoie une erreur, consultez Codes d'erreur HappyOyster pour la résoudre.
Étapes suivantes
Une fois que le World passe à l'état ready :
- Get Travel Credential : échanger contre un
ticketà usage unique. - Interroger les détails du Monde : interroger toutes les métadonnées de création.