新增区域 | OceanBase 文档中心

新增区域

更新时间：2023-08-10 11:45:58

功能说明

添加主机区域信息。

调用说明

接口约束

调用者需要具备 HOST_MANAGER 权限。

请求路径

POST /api/v2/compute/regions

请求参数

参数	类型	必选	示例值	描述
name	String	是	Beijing	区域名称
description	String	否	北京地区	区域描述信息

返回结果

参数	类型	说明
data	Object	请求的 Region 信息
successful	Boolean	请求是否成功
timestamp	Datetime	服务端完成请求的时间戳
duration	Integer	服务端处理请求的时间（毫秒）
status	Integer	符合 HTTP Status 规范的编码
traceId	String	请求的 Trace ID，用于排查问题
server	String	响应请求的应用服务的地址

Region 的数据结构

参数	类型	说明
id	Integer	区域 ID
name	String	区域名称
description	String	区域描述信息
createTime	String	区域信息创建时间
updateTime	String	区域信息修改时间

示例

请求示例

POST /api/v2/compute/regions

curl --user <username>:<password> -X POST 'http://<IP>:<PORT>/api/v2/compute/regions' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"shanghai","description":"上海"}'

返回示例

{
  "data": {
    "createTime": null,
    "id": 3000003,
    "name": "shanghai",
    "updateTime": null
  },
  "duration": 41,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-08-25T16:00:19.895+08:00",
  "traceId": "c8e610e3b33a4b17"
}