Skip to main content

Referência da API HappyOyster-Directing-Query Travel List

Paginar pelas Viagens do Directing na conta principal atual, com filtragem opcional por status ou Mundo associado.

Escopo

Paginar pelas Viagens de Direção na conta principal atual, com filtragem opcional por status ou Mundo 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).
  • Caller: Chamado pelo seu servidor.

Solicitação HTTP

  • Singapore
  • EUA (Virgínia)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travelsSubstitua {WorkspaceId} pelo seu ID do Workspace real.

Parâmetros da solicitação

  • Consultar lista de Viagens
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/travels?page=1&pageSize=20&status=completed&encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
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:
  • init: inicializando recursos da sessão
  • pending: na fila ou aguardando recursos do serviço
  • running: em execução
  • failed: a Travel falhou
  • completed: a Viagem terminou; os artefatos podem ser consultados
encryptedWorldId string (Opcional)Um ID de Mundo criptografado do Directing na conta principal atual. Quando fornecido, apenas as Viagens desse Mundo são retornadas. Este endpoint limita automaticamente os resultados ao modelo Directing e não suporta o parâmetro de consulta mode.

Parâmetros de resposta

Query succeeded
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedTravelId": "trvl_a1b2****",
                "status": "completed",
                "mode": 2,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": 180,
                "createdAt": "2026-06-03T10:00:00Z",
                "endedAt": "2026-06-03T10:03:00Z"
            },
            {
                "encryptedTravelId": "trvl_g7h8****",
                "status": "completed",
                "mode": 2,
                "encryptedWorldId": "enc_a1b2****",
                "durationSec": null,
                "createdAt": "2026-06-03T11:00:00Z",
                "endedAt": "2026-06-03T11:03:00Z"
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 20,
            "total": 2,
            "hasMore": false
        }
    }
}
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 Viagens na página atual; um array vazio quando não há resultado. Cada item contém encryptedTravelId, status, mode (sempre 2), encryptedWorldId, durationSec (null quando em execução ou quando o corte final ainda não está pronto), createdAt e endedAt (null quando em execução).pagination objectInformações de paginação. Contém page, pageSize, total e hasMore.

Estados pré-requisitos e notas de chamada

  • O filtro de modelo entra em vigor automaticamente, e items[].mode é sempre 2.
  • Ao filtrar com encryptedWorldId, esse Mundo deve pertencer à conta principal atual e ao modelo de Direção; um ID de Mundo de outro modelo retorna 403001.
  • Para uma Viagem em execução, durationSec e endedAt podem ser null.
  • Um status desconhecido não gera erro; é tratado como nenhum filtro de status. Para um status de pausa no lado do servidor, consulte uma única Viagem através de Consultar Status da Viagem.

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