Referencia de la API HappyOyster-Directing-Query World List - Alibaba Cloud Model Studio

Paginar a través de los Worlds de Directing bajo la cuenta principal actual. El endpoint está aislado automáticamente por modelo y nunca devuelve Worlds de Acting o Adventure.

Ámbito

Paginar a través de los Worlds de Directing bajo la cuenta principal actual. Antes de llamar, confirme lo siguiente:

Autenticación: Solo se admite la API Key principal; no se pueden utilizar API Keys temporales (código de error 403003).
- Obtenga la API Key principal: Obtener y configurar una API Key.
Caller: Llamado por su servidor.

Solicitud HTTP

Singapore

GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds

Reemplace {WorkspaceId} con su ID de espacio de trabajo real.

EE. UU. (Virginia)

GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds

Reemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

Lista de consulta de mundos

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 (Requerido)

Autenticación mediante API Key. Solo se admite la API Key principal; comienza con sk-, p. ej., sk-xxx. Normalmente se configura como la variable de entorno $DASHSCOPE_API_KEY. Una API Key temporal (que comienza con st-) devuelve 403003.

Parámetros de consulta

page integer (Opcional)

Número de página, el valor predeterminado es 1. Cuando page <= 0, se trata como 1.

pageSize integer (Opcional)

Elementos por página, el valor predeterminado es 20. Cuando pageSize <= 0, se trata como 20; cuando es mayor que 100, se limita a 100.

status string (Opcional)

Filtrar por estado de construcción. Los valores desconocidos no se aplican como filtro. Valores permitidos:

generating: construyendo
ready: listo
failed: error de construcción

mode integer (Opcional)

No es necesario pasar esto. La lista ya está filtrada al modelo Directing, y items[].mode siempre es 2. Si aun así lo pasa y el valor no es 2, se devuelve 400000.

Parámetros de respuesta

Consulta exitosa

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

Código de retorno. 0 indica éxito; un valor distinto de cero es un código de error.

message string

Mensaje de error. null en caso de éxito.

data object

Datos de respuesta. null en caso de fallo.

Propiedades

items array

Los Worlds en la página actual; una matriz vacía cuando no hay resultados. Cada elemento contiene encryptedWorldId, name, status (generating / ready / failed), mode (siempre 2), perspective (generalmente null), creationModel (simple / scriptlist), uploadMode (generalmente null) y createdAt.

pagination object

Información de paginación. Contiene page, pageSize, total y hasMore (true cuando page × pageSize < total).

Estados previos y notas de llamada

Los elementos de la lista son instantáneas ligeras; no devuelven imágenes, scriptList ni aspectRatio. Cuando necesite los metadatos completos, llame a Query World Detail mediante encryptedWorldId.
Un valor desconocido de status no genera error; se trata como si no hubiera filtro de estado.
Al paginar, utilice pagination.pageSize y hasMore de la respuesta; no asuma que los valores solicitados se adoptan textualmente.

Códigos de error

Si la llamada al modelo falla y devuelve un error, consulte Códigos de error de HappyOyster para resolverlo.

Siguientes pasos

Consulta de detalles del mundo: vea los metadatos completos de un solo mundo.
Eliminar World: elimine un World que ya no utilice.