Skip to main content

Referência da API HappyOyster-Directing-Query World Build Status

Consulte o progresso de construção de um Mundo do Directing. A API retorna o ID de Mundo criptografado, o status de construção e a URL do primeiro quadro; o cliente faz polling até que o Mundo entre no estado ready.

Escopo

Consulte o progresso de construção de um Mundo do Directing. Antes de chamar, confirme o seguinte:
  • Autenticação: A chave de API primária não é necessária; tanto a chave primária quanto uma temporária podem chamar este endpoint. Para saber como obtê-las, veja Obter credenciais de autenticação.
  • Pré-requisitos: Consulte com o encryptedWorldId retornado por Criar Mundo. Você pode começar a consultar a partir do estado generating.
  • Chamador: Tanto seu servidor quanto seu cliente podem fazer a chamada.

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/worlds/build-statusSubstitua {WorkspaceId} pelo seu ID do Workspace real.

Parâmetros da solicitação

  • Consultar status de construção do Mundo
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds/build-status?encryptedWorldId={encryptedWorldId}' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY"
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.
  • API Key Primária: começa com sk-, ex. sk-xxx.
  • Chave de API Temporária: começa com st-, por exemplo, st-xxx.
Parâmetros de consulta
encryptedWorldId string (Obrigatório)O ID de Mundo criptografado do Directing retornado por Criar Mundo.

Parâmetros de resposta

  • Construindo
  • Construção concluída
{
    "code": 0,
    "message": null,
    "data": {
        "encryptedWorldId": "enc_a1b2****",
        "status": "generating",
        "firstFrame": null
    }
}
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

encryptedWorldId stringID do Mundo criptografado.status stringStatus da construção: generating / ready / failed.firstFrame stringURL do primeiro quadro do Mundo; null quando ainda não gerado ou quando a construção falhou.name stringNome do Mundo. Retornado apenas quando status=ready.mode integerSempre 2 para Directing. Retornado apenas quando status=ready.

Estados pré-requisitos e notas de chamada

  • Sonde a cada 3–5 segundos até que status seja ready ou failed.
  • Apenas um Mundo ready pode trocar por uma credencial de viagem e entrar na sala.
  • Quando uma imagem de URL falha na validação após o armazenamento assíncrono, o Mundo pode passar de generating para failed.
  • Este endpoint não retorna aspectRatio.

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 o Mundo entra em ready: