Skip to main content

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

Paginar pelos Mundos do Directing na conta principal atual. O endpoint é isolado automaticamente por modelo e nunca retorna Mundos de Acting ou Adventure.

Escopo

Paginar pelos Mundos do Directing na conta principal atual. 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/worldsSubstitua {WorkspaceId} pelo seu ID do Workspace real.

Parâmetros da solicitação

  • Consultar lista de Mundos
curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds?page=1&pageSize=20&status=ready' \
    -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)Filtrar por status de construção. Valores desconhecidos não são aplicados como filtro. Valores permitidos:
  • generating: construindo
  • ready: pronto
  • failed: falha na construção
mode integer (Opcional)Não é necessário passar isso. A lista já está filtrada para o modelo Directing, e items[].mode é sempre 2. Se você ainda assim o passar e o valor não for 2, 400000 será retornado.

Parâmetros de resposta

  • Consulta bem-sucedida
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedWorldId": "enc_a1b2****",
                "name": "Midnight Visitor",
                "status": "ready",
                "mode": 2,
                "perspective": null,
                "creationModel": "scriptlist",
                "uploadMode": null,
                "createdAt": "2026-06-03T10:00:00Z"
            },
            {
                "encryptedWorldId": "enc_g7h8****",
                "name": "Neon Alley",
                "status": "ready",
                "mode": 2,
                "perspective": null,
                "creationModel": "simple",
                "uploadMode": null,
                "createdAt": "2026-06-03T12:00: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 arrayOs Mundos na página atual; um array vazio quando não há resultado. Cada item contém encryptedWorldId, name, status (generating / ready / failed), mode (sempre 2), perspective (geralmente null), creationModel (simple / scriptlist), uploadMode (geralmente null) e createdAt.pagination objectInformações de paginação. Contém page, pageSize, total e hasMore (true quando page × pageSize < total).

Estados pré-requisitos e notas de chamada

  • Os itens da lista são snapshots leves; eles não retornam imagens, scriptList ou aspectRatio. Quando você precisar dos metadados completos, chame Consultar Detalhes do Mundo por encryptedWorldId.
  • Um status desconhecido não gera erro; é tratado como ausência de filtro de status.
  • Ao paginar, use pagination.pageSize e hasMore da resposta; não assuma que os valores solicitados são adotados literalmente.

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