Tradução de apoio para consulta. Código e identificadores técnicos preservados. Consultar referência original ↗

HappyOyster Códigos de erro

HappyOyster Estrutura de resposta de API aberta e códigos de erro, incluindo códigos de negócios, cenários típicos e sugestões de tratamento.

Este documento descreve a estrutura de resposta e os códigos de erro do HappyOyster API aberta. Aplica-se a todos os endpoints de API aberta dos modelos Adventure, Directing e Acting.

Estrutura de resposta

Depois que uma solicitação passa pela autenticação do gateway (tanto para sucesso comercial quanto para erros comerciais), a resposta sempre retorna HTTP 200 com a seguinte estrutura JSON como corpo:

{
  "code": 0,
  "message": null,
  "data": {}
}

Campo	Tipo	Descrição
`code`	inteiro	Código de retorno comercial. `0` significa sucesso; um não-`0` valor significa um erro comercial — veja a lista de códigos de erro abaixo.
`message`	cadeia \	nulo
`data`	objeto \	nulo

Falhas na camada de gateway, como AK, assinatura ou verificação de carimbo de data/hora, são rejeitadas diretamente, portanto, essas respostas não seguem essa estrutura e normalmente são retornadas com um código de status HTTP 4xx/5xx.

Lista de códigos de erro

código	Descrição	Cenários típicos e manuseio
`0`	Sucesso	Solicitação bem-sucedida; leia `data`.
`400000`	Parâmetros de solicitação inválidos	`mode` não corresponde ao modelo atual; `prompt` ou `firstFrameImage` está faltando; `prompt` é muito longo; `creationModel` / `uploadMode` / `resolution` / `aspectRatio` / `perspective` tem um valor ilegal; imagem ou formato de ID criptografado é inválido. Corrija os parâmetros de acordo com o documento da API e tente novamente.
`400001`	Falha ao buscar ou armazenar o URL da imagem	O URL do primeiro quadro ou da imagem de referência está inacessível ou expirou. Verifique a acessibilidade e a validade do URL e tente criar novamente o World.
`401010`	`ticket` inválido ou expirado	Insira a viagem (enter-viagem). Chame get-travel-credential novamente para obter um novo `ticket`.
`401011`	`ticket` já usado	Insira viagens. O `ticket` é de uso único; obter um novo.
`403001`	O mundo não existe, foi excluído, não pertence a você ou não pertence ao modelo atual	Consulta, troca de credenciais, inserção de viagens e filtragem de listas. Na exclusão, esse código é retornado somente para IDs de várias contas, vários espaços de trabalho ou vários modelos; um ID já inexistente na mesma conta retorna `code=0, deleted=false`.
`403002`	Mundo não é `ready` ou indisponível	Troca de credenciais, insira viagem. Pesquise o status da compilação até `ready` antes de operar.
`403003`	Este endpoint permite apenas a chave de API primária	Gerenciamento mundial, lista de viagens, artefatos, etc. Chame com a chave API primária (começa com `sk-`).
`403004`	O conteúdo de entrada falhou na política de segurança de conteúdo	Crie um mundo, envie `instruct`. Ajuste o conteúdo do texto e tente novamente.
`403005`	A imagem de entrada falhou na verificação de direitos autorais ou IP	Criar mundo. Substitua por uma imagem compatível e tente novamente.
`403007`	Cota de recurso ou serviço não habilitada	Crie, troque credenciais, insira viagens. Confirme se o recurso do modelo correspondente está habilitado.
`403008`	Configuração de capacidade temporariamente indisponível	Crie, troque credenciais, insira viagens. Tente novamente mais tarde ou entre em contato com o provedor de serviços para aumentar a escala.
`404000`	A viagem não existe, não pertence a você, não pertence ao modelo atual ou não possui artefatos disponíveis	Consulta de status de viagem, controle, final, consulta de artefatos.
`409000`	A solicitação entra em conflito com o estado atual do recurso	Controlar endpoints como pausar, retomar, encerrar e instruir; também retornado ao chamar um endpoint que um modelo não suporta.
`429001`	A simultaneidade para a especificação atual está completa	Insira viagens. Tente novamente mais tarde ou aumente a especificação de simultaneidade.
`429002`	Capacidade disponível insuficiente	Insira viagens. Tente novamente mais tarde.
`500000`	Erro interno do sistema	Exceções não classificadas; também pode ser retornado ao chamar um endpoint não suportado (por exemplo, `rewind` em alguns modelos).
`500001`	Falha ao alocar recursos de streaming	Insira viagens. Tente novamente mais tarde.

Isolamento de modelo

Para evitar revelar através da resposta se existe um recurso de outro modelo, o acesso entre modelos é tratado uniformemente como "não encontrado":

O lado mundial retorna uniformemente 403001.
O lado Viagem retorna uniformemente 404000.