Référence de l'API HappyOyster-Directing-Query World List - Alibaba Cloud Model Studio

Paginer à travers les Mondes Directing sous le compte principal actuel. Le point de terminaison est automatiquement isolé par modèle et ne retourne jamais de Mondes Acting ou Adventure.

Scope

Paginer à travers les Mondes Directing sous le compte principal actuel. 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.
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

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

Remplacez {WorkspaceId} par votre véritable ID d'espace de travail.

Paramètres de la requête

Interroger la liste des Worlds

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds?page=1&pageSize=20&status=ready' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Authorization string (Requis)

Authentification par clé API. Seule la clé API principale est prise en charge ; elle commence par sk-, par ex. sk-xxx. Elle est généralement configurée comme variable d'environnement $DASHSCOPE_API_KEY. Une clé API temporaire (commençant par st-) renvoie 403003.

Paramètres de requête

page integer (Facultatif)

Numéro de page, par défaut 1. Lorsque page <= 0, il est traité comme 1.

pageSize integer (Facultatif)

Éléments par page, par défaut 20. Lorsque pageSize <= 0, il est traité comme 20 ; lorsqu'il est supérieur à 100, il est plafonné à 100.

status string (Facultatif)

Filtrer par statut de construction. Les valeurs inconnues ne sont pas appliquées comme filtre. Valeurs autorisées :

generating : en cours de construction
ready : prêt
failed : échec de la construction

mode integer (Facultatif)

Inutile de passer ceci. La liste est déjà filtrée pour le modèle Directing, et items[].mode est toujours 2. Si vous le passez tout de même et que la valeur n'est pas 2, 400000 est retourné.

Paramètres de réponse

Requête réussie

{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedWorldId": "enc_a1b2****",
                "name": "Midnight Visitor",
                "status": "ready",
                "mode": 2,
                "perspective": null,
                "creationModel": "scriptlist",
                "uploadMode": null,
                "createdAt": "2026-06-03T10:00:00Z"
            },
            {
                "encryptedWorldId": "enc_g7h8****",
                "name": "Neon Alley",
                "status": "ready",
                "mode": 2,
                "perspective": null,
                "creationModel": "simple",
                "uploadMode": null,
                "createdAt": "2026-06-03T12:00:00Z"
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 2,
            "hasMore": false
        }
    }
}

code integer

Code de retour. 0 indique un succès ; une valeur non nulle correspond à un code d'erreur.

message string

Message d'erreur. null en cas de succès.

data object

Données de réponse. null en cas d'échec.

Propriétés

items array

Les Mondes sur la page actuelle ; un tableau vide lorsqu'il n'y a aucun résultat. Chaque élément contient encryptedWorldId, name, status (generating / ready / failed), mode (toujours 2), perspective (généralement null), creationModel (simple / scriptlist), uploadMode (généralement null) et createdAt.

pagination object

Informations de pagination. Contient page, pageSize, total et hasMore (true lorsque page × pageSize < total).

États préalables et notes d'appel

Les éléments de la liste sont des instantanés légers ; ils ne retournent pas les images, scriptList ou aspectRatio. Lorsque vous avez besoin des métadonnées complètes, appelez Interroger les détails du monde par encryptedWorldId.
Un status inconnu ne déclenche pas d'erreur ; il est traité comme une absence de filtre de statut.
Lors de la pagination, utiliser pagination.pageSize et hasMore de la réponse ; ne pas supposer que les valeurs demandées sont adoptées telles quelles.

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

Query World Detail : afficher les métadonnées complètes d'un seul World.
Delete World : supprimer un World que vous n'utilisez plus.