Skip to main content

Referencia de la API de consulta de lista de Travels de HappyOyster-Adventure

Paginación a través de los Travels de Adventure bajo la cuenta principal actual, con filtrado opcional por estado o World asociado.

Ámbito

Paginación a través de los Travels de Adventure bajo la cuenta principal actual, con filtrado opcional por estado o World asociado. Antes de realizar la llamada, confirme lo siguiente:
  • Autenticación: Solo se admite la API Key principal; no se pueden utilizar API Keys temporales (código de error 403003).
  • Caller: Llamado por su servidor.

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/travelsReemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud

  • Consultar lista de Travels
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels?page=1&pageSize=20&status=completed&encryptedWorldId={encryptedWorldId}' \
    -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 del Travel. Los valores desconocidos no se aplican como filtro. Valores permitidos:
  • init: inicializando recursos de sesión
  • pending: en cola o esperando recursos del servicio
  • running: en ejecución
  • failed: el Travel falló
  • completed: el Travel ha finalizado; se pueden consultar los artefactos
encryptedWorldId string (Opcional)Un ID de World de Adventure bajo la cuenta principal actual. Cuando se proporciona, solo se devuelven los Travels de ese World. Este endpoint no admite el parámetro de consulta mode; la entrada específica del modelo limita automáticamente los resultados a Adventure.

Parámetros de respuesta

  • Consulta exitosa
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedTravelId": "trvl_a1b2****",
                "status": "completed",
                "mode": 1,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": 90,
                "createdAt": "2026-06-03T10:00:00Z",
                "endedAt": "2026-06-03T10:01:30Z"
            },
            {
                "encryptedTravelId": "trvl_g7h8****",
                "status": "running",
                "mode": 1,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": null,
                "createdAt": "2026-06-03T11:00:00Z",
                "endedAt": null
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 2,
            "hasMore": false
        }
    }
}
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

items arrayLos Travels en la página actual; una matriz vacía cuando no hay resultados. Cada elemento contiene encryptedTravelId, status, mode (siempre 1), encryptedWorldId, durationSec (null cuando está en ejecución, ha fallado o la duración aún no está disponible), createdAt y endedAt (null cuando aún está en ejecución).pagination objectInformación de paginación. Contiene page, pageSize, total y hasMore.

Estados previos y notas de llamada

  • El endpoint devuelve automáticamente solo Travels de Adventure, y items[].mode siempre es 1.
  • Al filtrar con encryptedWorldId, dicho World debe pertenecer a la cuenta principal actual y al modelo Adventure; un World de otro modelo devuelve 403001.
  • Para un Travel en ejecución, durationSec y endedAt suelen ser null.
  • Un valor desconocido de status no genera error; se trata como si no hubiera filtro de estado.
  • Un resultado vacío no constituye un error; devuelve items=[] y la información de paginación correspondiente.

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