Skip to main content

HappyOyster-Directing-查询World列表 API参考

分页查询当前主账号名下的 Directing World。接口自动按模型隔离,不会返回 Acting 或 Adventure World。

适用范围

分页查询当前主账号名下的 Directing World。调用前请确认以下事项:
  • 鉴权要求:仅支持主 API Key调用,临时 API Key 不可用(错误码 403003)。
  • 调用方:您的服务端调用。

HTTP调用

  • 新加坡
  • 美国(弗吉尼亚)
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-directing/openapi/v1/worlds调用时请将{WorkspaceId}替换为真实的Workspace ID。

请求参数

  • 查询World列表
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 (必选)API Key 鉴权。仅支持主 API Key,以 sk- 开头,如 sk-xxx。通常配置为环境变量 $DASHSCOPE_API_KEY。临时 API Key(st- 开头)调用返回 403003。
Query 参数
page integer (可选)页码,默认 1。page <= 0 时按 1 处理。
pageSize integer (可选)每页条数,默认 20。pageSize <= 0 时按 20,大于 100 时按 100 处理。
status string (可选)按构建状态筛选。未知值不筛选。可选值:
  • generating:构建中
  • ready:就绪
  • failed:构建失败
mode integer (可选)无需传入。列表已按 Directing 模型过滤,items[].mode 恒为 2。若仍传入且非 2 返回 400000。

响应参数

  • 查询成功
{
    "code": 0,
    "message": null,
    "data": {
        "items": [
            {
                "encryptedWorldId": "enc_a1b2****",
                "name": "午夜访客",
                "status": "ready",
                "mode": 2,
                "perspective": null,
                "creationModel": "scriptlist",
                "uploadMode": null,
                "createdAt": "2026-06-03T10:00:00Z"
            },
            {
                "encryptedWorldId": "enc_g7h8****",
                "name": "霓虹小巷",
                "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 integer返回码。0 表示成功,非 0 为错误码。
message string错误信息。成功时为 null。
data object响应数据。失败时为 null。

属性

items array当前页 World 列表;无结果时为空数组。每项含 encryptedWorldId、name、status(generating / ready / failed)、mode(恒为 2)、perspective(通常为 null)、creationModel(simple / scriptlist)、uploadMode(通常为 null)、createdAt。pagination object分页信息。含 page、pageSize、total、hasMore(page × pageSize < total 时为 true)。

前置状态与调用注意事项

  • 列表项是轻量快照,不返回图片、scriptList 或 aspectRatio。需要完整元数据时,按 encryptedWorldId 调用查询World详情。
  • 未知 status 不会报错,而是按不筛选状态处理。
  • 翻页时应使用响应中的 pagination.pageSize 和 hasMore,不要假设请求值一定原样采用。

错误码

如果模型调用失败并返回报错信息,请参见HappyOyster 错误码进行解决。

下一步

文本生成
图像生成
视频生成
3D模型生成
音频
  • 音频生成
Realtime API
  • 概述
向量与排序
决策模型
TokenPlan
模型生产