Encerre ativamente uma Adventure Travel. Após um término normal, ela entra em completed; em um término por tempo limite sem stream, ela entra em failed e nenhum artefato de replay é gerado. O servidor também a encerra automaticamente quando maxExperienceTimeSec é atingido.
Escopo
Encerre ativamente uma Adventure Travel. Após um término normal, a Travel entra em completed; em um término por tempo limite sem stream, ela entra em failed. Antes de chamar, confirme o seguinte:
- Autenticação: A Chave de API primária não é obrigatória; tanto a chave primária quanto uma temporária podem chamá-la. Para saber como obtê-las, veja Obter credenciais de autenticação.
- Pré-requisitos: A Travel ainda não deve ter entrado em um estado terminal e deve estar em um estado que o servidor possa encerrar. Confirme via Consultar Status da Travel.
- Chamador: Tanto seu servidor quanto seu cliente podem fazer a chamada.
Solicitação HTTP
- Singapore
- China (Pequim)
- EUA (Virgínia)
POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/travels/endSubstitua {WorkspaceId} pelo seu ID do Workspace real.Parâmetros da solicitação |
|
Content-Typestring(Obrigatório)Tipo de conteúdo da solicitação. Este parâmetro deve ser definido como application/json. | |
Authorization string (Obrigatório)Autenticação por Chave de API. A Chave de API primária não é obrigatória; tanto a chave primária quanto uma temporária podem chamá-lo.
| |
Corpo da solicitação | |
encryptedTravelId string (Obrigatório)O ID criptografado da Adventure Travel a ser encerrada. Retornado por Entrar na Travel. | |
failCode string (Opcional)O motivo de término de falha para um tempo limite sem fluxo. Quando omitido, é tratado como um término normal. Atualmente, apenas suportado:
400000. | |
userAgent string (Opcional)Identificador de versão do SDK ou cliente. Uma string não vazia; tem precedência sobre o User-Agent HTTP. |
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 encryptedTravelId stringO ID da Viagem criptografado que foi encerrado.status stringStatus final:
stringCódigo do motivo da falha; null em um término normal.errorMessage stringDescrição da falha; null em um término normal.endedAt stringHora de término, no formato ISO 8601.durationSec integerDuração efetiva do vídeo em segundos; null em um término de falha sem fluxo ou quando a duração ainda não puder ser analisada. |
Estados pré-requisitos e notas de chamada
- O
encryptedTravelIddeve pertencer à conta principal atual e ao modelo Adventure. - Quando
failCodeé omitido, é tratado como um término normal; passar um valor não suportado retorna400000. - O servidor encerra automaticamente a Travel assim que
maxExperienceTimeSecé atingido; o cliente deve convergir seu estado local a partir de callbacks de status ou resultados de consulta de status. - Em um término normal,
durationSecusa preferencialmente a duração real do vídeo finalizado disponível; pode sernullquando a duração do vídeo finalizado ainda não puder ser analisada. - Após um término normal atingir
completed, os artefatos compostos ainda podem estar sendo processados; consulte-os e sonde-os conforme Consultar Artefatos da Travel.
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
Depois que a Viagem entrar em completed:
- Consultar Artefatos da Travel: sondar para obter as variantes originais e compostas gravadas.
- Consultar Lista de Travels: visualizar Travels históricas.