平台设置
根域名变更会经过根域名校验器,并受授权检查限制;后续路由子域名展开使用该值。
| 方法 | 路径(产品接口统一前缀 /api/v1) | 功能 |
|---|---|---|
| GET | /settings/route-root-domain | 读取路由根域名 |
| PUT | /settings/route-root-domain | 更新路由根域名 |
读取路由根域名
功能介绍
读取路由根域名。
访问要求:有效 Token;需要对应资源读权限,并受项目、所有者、公共或共享资源规则限制。
URI
GET /api/v1/settings/route-root-domain
请求消息
无请求体。
响应消息
| 参数 | 参数类型 | 描述 |
|---|---|---|
| rootDomain | string | 路由根域名 |
请求示例
GET https://{endpoint}/api/v1/settings/route-root-domain
x-keystone-token: <Keystone Token>
正常响应示例
HTTP/1.1 200
Content-Type: application/json
{
"rootDomain": "ai.example.com"
}
状态码与错误码
成功状态码:200。
| HTTP | error | 说明 |
|---|---|---|
| 500 | internal_error | failed to read setting |
| 401 | unauthorized | missing principal |
此外,认证/授权中间件可返回 401 / 403;后端错误与错误封装见调用方式。
更新路由根域名
功能介绍
更新路由根域名。
访问要求:Token + 对应写权限,且要求 cloud_admin 角色。
URI
PUT /api/v1/settings/route-root-domain
请求消息
Content-Type: application/json。
| 参数 | 参数类型 | 是否必选 | 描述 |
|---|---|---|---|
| rootDomain | string | 是 | 路由根域名 |
响应消息
| 参数 | 参数类型 | 描述 |
|---|---|---|
| rootDomain | string | 路由根域名 |
请求示例
PUT https://{endpoint}/api/v1/settings/route-root-domain
x-keystone-token: <Keystone Token>
Content-Type: application/json
{
"rootDomain": "ai.example.com"
}
正常响应示例
HTTP/1.1 200
Content-Type: application/json
{
"rootDomain": "ai.example.com"
}
状态码与错误码
成功状态码:200。
| HTTP | error | 说明 |
|---|---|---|
| 403 | forbidden | 只有云管理员可以修改根域名 |
| 400 | invalid_request | invalid request body |
| 500 | internal_error | setting has no validator |
| 401 | unauthorized | missing principal |
此外,认证/授权中间件可返回 401 / 403;后端错误与错误封装见调用方式。