Skip to main content

Referencia de la API de consulta de estado de construcción de World de HappyOyster-Adventure

Consulta el progreso de construcción de un World de Adventure. La API devuelve el ID de World cifrado, el estado de construcción y la URL del primer fotograma; el cliente sondea hasta que el World entra en estado ready.

Ámbito

Consulta el progreso de construcción de un World de Adventure. Antes de realizar la llamada, confirme lo siguiente:
  • Autenticación: La clave API principal no es obligatoria; este endpoint puede invocarse con la clave principal o con una clave API temporal. Para saber cómo obtenerlas, consulte Obtener credenciales de autenticación.
  • Requisitos previos: Consulte con el encryptedWorldId devuelto por Create World. Puede comenzar a consultar desde el estado generating.
  • Solicitante: Puede invocarla su servidor o su cliente.

Solicitud HTTP

  • Singapore
  • China (Beijing)
  • EE. UU. (Virginia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/build-statusReemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

  • Consultar estado de construcción de World
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/build-status?encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
Authorization string (Requerido)Autenticación mediante clave de API. No se requiere la clave de API principal; pueden invocarla tanto la clave principal como una temporal.
  • Clave de API principal: comienza con sk-, por ejemplo, sk-xxx.
  • Clave de API temporal: comienza con st-, por ejemplo, st-xxx.
Parámetros de consulta
encryptedWorldId string (Requerido)El ID de World cifrado devuelto por Create World. Está cifrado por el servidor; no necesita descifrarlo.

Parámetros de respuesta

  • En construcción
  • Construcción completada
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "generating",
        "firstFrame": null
    }
}
code integerCódigo de retorno. 0 indica éxito; un valor distinto de cero es un código de error.
message stringMensaje de error. null en caso de éxito.
data objectDatos de respuesta. null en caso de fallo.

Propiedades

encryptedWorldId stringID de World cifrado.status stringEstado de construcción:
  • generating: construyendo
  • ready: listo; puede canjearlo por una credencial de travel e ingresar a la sala
  • failed: error de construcción
firstFrame stringURL del primer fotograma del World; null cuando aún no se ha generado o cuando la construcción falló.name stringNombre del World. Se devuelve solo cuando status=ready.mode integerSiempre 1 para Adventure. Se devuelve solo cuando status=ready.

Estados previos y notas de llamada

  • Sondee cada 3–5 segundos hasta que status sea ready o failed.
  • Solo un World en estado ready puede canjearse por una credencial de travel y entrar a la sala.
  • Cuando una imagen de URL falla la validación tras el almacenamiento asíncrono, el World puede pasar de generating a failed.
  • Este endpoint no devuelve aspectRatio; cuando necesite metadatos de creación como perspective o uploadMode, llame a Query World Detail.

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

Después de que el World entra en ready: