Skip to main content
Alias 用于查询、设置和重置项目官方域名的前缀。例如把默认前缀改为 event-demo,官方域名后缀保持不变。它不会修改项目的 url_id,后续项目接口仍使用原来的 project_id;也不会绑定独立域名、触发构建或发布。 本节为 0915 新增接口,当前可在预发 8 联调,生产可用性以正式发布为准。以下示例使用预发地址;响应中的 apps.example.com 仅为域名后缀示意,真实后缀以接口返回的 domain_suffix 为准。

接口与权限

  • project_id 使用原项目公开 url_id,不是数据库主键,也不是新设置的 Alias。
  • 查询和可用性检查要求项目访问地址的查看权限。设置和重置要求项目 Owner 或该租户管理员权限,且项目状态允许操作。
  • Scope 与项目权限同时校验。project.readproject.writecli.compat 不替代 alias.readalias.writealias.write 也不自动包含 alias.read
  • 开放集成账号必须使用团队委托 Token,不能用 OAuth 或 API Key 调用。其他账号的凭证类型按认证与授权规则执行;可配置项目 API Key 的账号可以选择 alias.read / alias.write,该 Key 仍只能访问绑定项目。
  • 首次从默认前缀改成自定义前缀,需要可用的 custom_domains 权益。已有自定义前缀的改名、同值提交及恢复默认值不额外要求剩余权益。

前缀规则

alias 为必填字符串,服务端先去除首尾空白并转小写。自定义前缀归一化后须为 5~24 个字符,只允许英文字母、数字和中划线,首尾不能为中划线;不能传完整 URL、域名或包含下划线的自定义值。 其他项目已占用的前缀、其他项目的默认 url_id、系统保留名或审核不通过的名称不可用。名称占用检查不因官方后缀不同而放宽;项目改名后,其默认 url_id 仍被保留。提交本项目默认 url_id 时恢复默认,不受上述自定义名称格式限制。 PUT 不接受空字符串或 null 来表示重置。建议用 DELETE 显式重置;PUT 和 availability 的参数均只接受 alias,未知字段返回 400。

公共请求变量

查询当前 Alias

成功返回 HTTP 200。GET、PUT、DELETE 使用相同的配置响应结构:
access_url 仅表示配置的访问地址,不保证应用已经发布或当前可访问。有独立域名时,access_url 可能不同于 https://primary_domain

检查可用性

Query 参数 alias 必填。示例中的空白和大写会归一化为 event-demo
available 为 boolean。名称不可用时通常仍返回 HTTP 200、available:false;格式错误返回 400,审核服务异常返回 503。本项目当前前缀视为可用。 可用性查询只检查名称,不预留名称,不保证调用方拥有写权限、剩余权益或后续写入一定成功。即使返回 true,实际 PUT 仍可能因并发占用返回 409,或因权益不足返回 403。

设置或修改 Alias

请求体仅包含必填字符串 alias。成功返回 HTTP 200 和更新后的完整配置。修改已设置的自定义前缀使用同一个 PUT 接口。 重复提交相同目标值具有幂等语义,不重复占用权益。发生网络超时可以先 GET 确认当前配置,再按需重试同值 PUT。响应成功表示配置已提交,关联配置同步可能稍后生效;同值 PUT 可用于重试关联同步。客户端应以返回配置为准,不把接口成功当作站点已经发布或域名已可访问。 改名不提供旧自定义地址保留或重定向保证,应更新对外分享地址。

恢复默认前缀

DELETE 不带请求字段,不删除项目或官方域名记录。成功返回 HTTP 200,此时 alias 等于 default_aliasis_custom_alias 为 false。重复 DELETE 仍返回默认配置,不要求剩余自定义域名权益。PUT 提交本项目默认 url_id 也可恢复默认。

限流

以下限额分别按接口桶统计;PUT 和 DELETE 共用写入桶。任一维度达到限制均可能返回 429。 发生 429 时按 Retry-After 等待后重试。错误请求也可能计入已通过的限流检查,批量参数自测或轮询应控制频率。

常见错误

错误响应使用 application/problem+json,包含 statuscodedetailtrace_id。保留 trace_id 便于排查;响应头也提供 X-Meoo-Trace-Id