接口参考地域、可用区与集群
修改地域
PUT /api/admin/v1/regions/{region_id},updateRegion 的请求参数和响应结构。
PUT /api/admin/v1/regions/{region_id}
| 项目 | 内容 |
|---|---|
| 操作标识 | updateRegion |
| 认证 | 登录会话 Cookie |
平台基础设施目录,真实持久化于 PostgreSQL。写操作要求 infrastructure.manage、Origin 与 CSRF;目录登记不创建底层集群或启用调度。
会话写请求需要合法的 Origin 和与当前 Cookie 绑定的 X-CSRF-Token。登录成功后应重新获取 CSRF 令牌。具体权限由目标资源归属和当前授权决定,见认证约定。
请求参数
| 名称 | 位置 | 必填 | 类型 | 说明与约束 |
|---|---|---|---|---|
| region_id | path | 是 | string | 格式:uuid |
| X-CSRF-Token | header | 是 | string | — |
请求体
请求体必填。
内容类型:application/json。
| 字段 | 类型 | 必填 | 说明与约束 |
|---|---|---|---|
| name | string | 是 | 最短 1;最长 64 |
| code | string | 是 | 创建后不可修改;正则:^[a-z][a-z0-9_-]{1,47}$ |
| status | string | 是 | 可选值:"enabled"、"disabled" |
| description | string | 否 | 最长 500;默认 "" |
| country_code | string | 否 | 国家/地区两字母大写代码;空字符串表示未指定。更新时省略则保留原值。;最长 2;正则:^([A-Z]{2})?$ |
完整请求结构(含引用定义)
{
"$ref": "#/$defs/RegionInput",
"$defs": {
"RegionInput": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"code": {
"type": "string",
"pattern": "^[a-z][a-z0-9_-]{1,47}$",
"description": "创建后不可修改"
},
"status": {
"type": "string",
"enum": [
"enabled",
"disabled"
]
},
"description": {
"type": "string",
"maxLength": 500,
"default": ""
},
"country_code": {
"type": "string",
"pattern": "^([A-Z]{2})?$",
"maxLength": 2,
"description": "国家/地区两字母大写代码;空字符串表示未指定。更新时省略则保留原值。"
}
},
"required": [
"name",
"code",
"status"
]
}
}
}响应
| HTTP 状态 | 含义 |
|---|---|
| 200 | 成功 |
| 400 | 错误 |
| 401 | 错误 |
| 403 | 错误 |
| 404 | 错误 |
| 409 | 错误 |
| 500 | 错误 |
| 503 | 错误 |
200 · application/json 响应结构
| 字段 | 类型 | 必填 | 说明与约束 |
|---|---|---|---|
| data | Region | 是 | — |
| request_id | string | 是 | — |
{
"$ref": "#/$defs/RegionResponse",
"$defs": {
"RegionResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/$defs/Region"
},
"request_id": {
"type": "string"
}
},
"required": [
"data",
"request_id"
]
},
"Region": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"code": {
"type": "string",
"pattern": "^[a-z][a-z0-9_-]{1,47}$",
"description": "创建后不可修改"
},
"status": {
"type": "string",
"enum": [
"enabled",
"disabled"
]
},
"description": {
"type": "string",
"maxLength": 500,
"default": ""
},
"id": {
"type": "string",
"format": "uuid"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"country_code": {
"type": "string",
"pattern": "^([A-Z]{2})?$",
"maxLength": 2,
"description": "国家/地区两字母大写代码;空字符串表示未指定。更新时省略则保留原值。"
}
},
"required": [
"name",
"code",
"status",
"description",
"id",
"created_at",
"updated_at",
"country_code"
]
}
}
}400 / 401 / 403 / 404 / 409 / 500 / 503 · application/json 响应结构
{
"$ref": "#/$defs/ErrorResponse",
"$defs": {
"ErrorResponse": {
"type": "object",
"additionalProperties": false,
"properties": {
"error": {
"$ref": "#/$defs/ErrorDetail"
},
"request_id": {
"type": "string"
}
},
"required": [
"error",
"request_id"
]
},
"ErrorDetail": {
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"enum": [
"NOT_IMPLEMENTED",
"NOT_FOUND",
"AUTH_REQUIRED",
"FORBIDDEN",
"VALIDATION_FAILED",
"CONFLICT",
"SERVICE_UNAVAILABLE",
"INTERNAL_ERROR",
"RATE_LIMITED"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"code",
"message",
"retryable"
]
}
}
}响应中的 request_id 用于排查请求;异步操作以任务最终状态为准。参阅调用约定、异步任务和错误处理。
本页由版本化 OpenAPI 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。
