跳转到正文
皓量云擎文档
接口参考地域、可用区与集群

创建地域

POST /api/admin/v1/regions,createRegion 的请求参数和响应结构。

POST /api/admin/v1/regions

项目内容
操作标识createRegion
认证登录会话 Cookie

平台基础设施目录,真实持久化于 PostgreSQL。写操作要求 infrastructure.manage、Origin 与 CSRF;目录登记不创建底层集群或启用调度。

会话写请求需要合法的 Origin 和与当前 Cookie 绑定的 X-CSRF-Token。登录成功后应重新获取 CSRF 令牌。具体权限由目标资源归属和当前授权决定,见认证约定。

请求参数

名称位置必填类型说明与约束
X-CSRF-Tokenheader是string—

请求体

请求体必填。

内容类型:application/json。

字段类型必填说明与约束
namestring是最短 1;最长 64
codestring是创建后不可修改;正则:^[a-z][a-z0-9_-]{1,47}$
statusstring是可选值:"enabled"、"disabled"
descriptionstring否最长 500;默认 ""
country_codestring否国家/地区两字母大写代码;空字符串表示未指定。更新时省略则保留原值。;最长 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 响应结构
字段类型必填说明与约束
dataRegion是—
request_idstring是—
{
  "$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 契约生成。通用资源响应允许的任意字段以运行服务为准,不据此推断尚未定义的字段。

本页目录