Interroger le statut actuel, les paramètres de création et les informations ScriptList retournables d'un seul Monde Directing. Pour le polling de la progression de la construction, utilisez le point de terminaison Query World Build Status.
Scope
Interroger le statut actuel, les paramètres de création et les informations ScriptList retournables d'un seul Monde Directing. Avant d'appeler, confirmez les points suivants :
-
Authentification : Seule la clé API principale est prise en charge ; les clés API temporaires ne peuvent pas être utilisées (code d'erreur
403003).- Obtenir la clé API principale : Obtenir et configurer une clé API.
-
Prérequis : Interroger avec l'
encryptedWorldIdretourné par Create World. Pour le sondage de la progression de la construction, utiliser Query World Build Status. -
Appelant : Appelé par votre serveur.
Requête HTTP
Singapore
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/detail
Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.
États-Unis (Virginie)
GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/detail
Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.
Paramètres de la requête | Interroger le détail du World |
Authorization Authentification par clé API. Seule la clé API principale est prise en charge ; elle commence par | |
Paramètres de requête | |
encryptedWorldId Un ID de Monde chiffré Directing sous le compte principal actuel. Retourné par Créer un monde. |
Paramètres de réponse | Requête réussie (mode script) |
code Code de retour. | |
message Message d'erreur. | |
data Données de réponse. |
États préalables et notes d'appel
- Ce point de terminaison peut interroger un Monde
generating,readyoufailed. - Il ne renvoie pas le champ
asyncde la requête de création. - Les champs d'image retournent uniquement l'URL et
referenceType, et ne retournent jamais base64. LesinputImagespour le modesimplesont persistants en tant qu'images de référence et peuvent être retournés dans le détail ;scriptlistn'accepte pas ce champ. - Lorsque
scriptListest analysé normalement, la structure stockée complète est retournée, etactsest retourné intégralement selon le contenu stocké ; en cas d'échec de l'analyse,scriptList=nullest retourné, et unactsvide n'est pas utilisé pour indiquer un échec d'analyse. - L'interrogation d'un World provenant d'un autre modèle, d'un autre compte principal, ou d'un World supprimé retourne toujours
403001, sans révéler si la ressource existe.
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
- Interroger la liste des mondes : paginer à travers tous les Mondes Directing.
- Delete World : supprimer un World que vous n'utilisez plus.
- Lorsque le World est
ready, vous pouvez Get Travel Credential.