Paginar pelas Viagens Adventure na conta principal atual, com filtragem opcional por status ou Mundo associado.
Escopo
Paginar pelas Adventure Travels sob a conta principal atual, com filtragem opcional por status ou World associado. Antes de chamar, confirme o seguinte:
-
Autenticação: Apenas a API Key primária é suportada; API Keys temporárias não podem ser usadas (código de erro
403003).- Obtenha a API Key primária: Obter e configurar uma API Key.
- Caller: Chamado pelo seu servidor.
Solicitação HTTP
- Singapore
- China (Pequim)
- EUA (Virgínia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travelsSubstitua {WorkspaceId} pelo seu ID do Workspace real.Parâmetros da solicitação |
|
Authorization string (Obrigatório)Autenticação por API Key. Apenas a API Key primária é suportada; ela começa com sk-, ex. sk-xxx. É tipicamente configurada como a variável de ambiente $DASHSCOPE_API_KEY. Uma API Key temporária (começando com st-) retorna 403003. | |
Parâmetros de consulta | |
page integer (Opcional)Número da página, o padrão é 1. Quando page <= 0, é tratado como 1. | |
pageSize integer (Opcional)Itens por página, o padrão é 20. Quando pageSize <= 0, é tratado como 20; quando maior que 100, é limitado a 100. | |
status string (Opcional)Filtra pelo status da Viagem. Valores desconhecidos não são aplicados como filtro. Valores permitidos:
| |
encryptedWorldId string (Opcional)Um ID de Adventure World sob a conta principal atual. Quando fornecido, apenas as Travels desse World são retornadas. Este endpoint não suporta o parâmetro de consulta mode; a entrada específica do modelo limita automaticamente os resultados a Adventure. |
Parâmetros de resposta |
|
code integerCódigo de retorno. 0 indica sucesso; diferente de zero é um código de erro. | |
message stringMensagem de erro. null em caso de sucesso. | |
data objectDados da resposta. null em caso de falha.
Propriedades items arrayAs Travels na página atual; um array vazio quando não há resultado. Cada item contém encryptedTravelId, status, mode (sempre 1), encryptedWorldId, durationSec (null quando em execução, falhada ou a duração ainda não está disponível), createdAt e endedAt (null quando ainda em execução).pagination objectInformações de paginação. Contém page, pageSize, total e hasMore. |
Estados pré-requisitos e notas de chamada
- O endpoint retorna automaticamente apenas Adventure Travels, e
items[].modeé sempre1. - Ao filtrar com
encryptedWorldId, esse World deve pertencer à conta principal atual e ao modelo Adventure; um World de outro modelo retorna403001. - Para uma Viagem em execução,
durationSeceendedAtgeralmente sãonull. - Um
statusdesconhecido não gera erro; é tratado como ausência de filtro de status. - Um resultado vazio não é um erro; ele retorna
items=[]e as informações de paginação correspondentes.
Códigos de erro
Se a chamada do modelo falhar e retornar um erro, consulte Códigos de Erro do HappyOyster para resolvê-lo.
Próximos passos
- Consultar Status da Viagem: consulta o status em tempo real de uma única Viagem.
- Consultar Artefatos da Viagem: consulta os artefatos de vídeo de uma Viagem concluída.