创建租户 - 云平台 OCP V4.3.0 | OceanBase 文档中心

创建租户

更新时间：2026-04-14 11:55:54

编辑

功能说明

在指定的集群下创建单个租户时使用的接口。

调用说明

接口约束

调用者需要通过 OCP 应用服务鉴权。

请求路径

POST /api/v2/ob/clusters/{id}/tenants/createTenant

请求参数

path：

参数	类型	必选	示例值	描述
id	Integer	是	2000017	目标租户所属集群在 OCP 端的集群 ID。

body：

参数	类型	必选	示例值	描述
name	String	是	foo	租户名称，集群下唯一。
mode	String	否	MYSQL	租户兼容模式，取值范围： ORACLE MYSQL
primaryZone	String	否	zone1,zone2;zone3	Zone 优先级。
charset	String	否	utf8mb4	字符集，取值范围： ORACLE 模式： utf8mb4 gbk gb18030 latin1 gb2312 gb18030_2022 ascii tis620 ujis euckr eucjpms cp932 utf16le sjis hkscs hkscs31 dec8 big5 cp850 hp8 macroman swe7 MYSQL 模式： binary gbk utf8mb4 latin1 gb2312 gb18030_2022 ascii tis620 ujis euckr eucjpms cp932 utf16le dec8 hkscs hkscs31 big5 cp850 hp8 macroman swe7 缺省为 utf8mb4。说明仅 OceanBase V4.3.5 BP1 及以上版本时支持如下字符集：gb2312、ujis、euckr、eucjpms、cp932、cp850、hp8、macroman 和 swe7。
collation	String	否	utf8mb4_general_ci	校验规则，取值范围： utf8mb4_general_ci utf8mb4_bin utf8mb4_unicode_ci utf8mb4_unicode_520_ci utf8mb4_croatian_ci utf8mb4_czech_ci utf8mb4_0900_ai_ci utf8mb4_german2_ci utf8mb4_croatian_ci binary gbk_chinese_ci gbk_bin utf8mb4_german2_ci utf8mb4_croatian_ci gb18030_chinese_ci gb18030_bin latin1_swedish_ci latin1_german1_ci latin1_danish_ci latin1_german2_ci latin1_general_ci latin1_general_cs latin1_spanish_ci latin1_bin gb18030_2022_bin gb18030_2022_chinese_ci gb18030_2022_chinese_cs gb18030_2022_radical_ci gb18030_2022_radical_cs gb18030_2022_stroke_ci gb18030_2022_stroke_cs ascii_bin ascii_general_ci tis620_bin tis620_thai_ci sjis_japanese_ci dec8_swedish_ci gb2312_chinese_ci gb2312_bin ujis_japanese_ci ujis_bin euckr_korean_ci euckr_bin eucjpms_japanese_ci eucjpms_bin cp932_japanese_ci cp932_bin cp850_general_ci cp850_bin hp8_english_ci hp8_bin macroman_general_ci macroman_bin swe7_swedish_ci swe7_bin 缺省为 utf8mb4_general_ci。说明仅 OceanBase V4.3.5 BP1 及以上版本时支持如下 collation：gb2312_chinese_ci、gb2312_bin、ujis_japanese_ci、ujis_bin、euckr_korean_ci、euckr_bin、eucjpms_japanese_ci、eucjpms_bin、cp932_japanese_ci、cp932_bin、cp850_general_ci 和 cp850_bin。 ORACLE 租户暂不支持此参数。
description	String	否	bar	租户备注信息。
whitelist	String	否	%	支持的格式有： IP地址，示例：xxx.xxx.xxx.1,xxx.xxx.xxx.2 子网/掩码，示例：xxx.xxx.xxx.3/24 模糊匹配，示例：xxx.xxx.xxx.% 或 xxx.xxx.xxx._ 多种格式混合，示例：xxx.xxx.xxx.1,xxx.xxx.xxx.2,xxx.xxx.xxx.%,xxx.xxx.xxx._,xxx.xxx.xxx.3/24 说明 % 表示所有客户端都可以连接缺省为 %。
rootPassword	String	是		管理员用户密码。 ORACLE 租户：SYS 用户 MYSQL 租户：root 用户密码强度说明：长度为 8 ~ 32，至少包含数字（0~9）、大写字母（A~Z）、小写字母（a~z）和特殊字符四种类型中的三种，支持的特殊字符为 `~!@#%^&*_-+=\|(){}[]:;,.?/`。
saveToCredential	Boolean	否	true	是否将租户管理员密码保存到到当前 ocp 登录用户的密码箱中。
zones	Array	是	--	--
├─name	String	是	zone1	集群下的 Zone 名。
├─replicaType	String	是	FULL	取值范围： FULL LOGONLY READONLY
├─resourcePool	Object	是		资源池。
├─unitSpecName	String	是	S1	可在 “Unit 规格管理” 页面上查看规格列表。
├─unitCount	Integer	是	1	Unit 个数。

返回结果

基础数据结构

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

示例

请求示例

POST /api/v2/ob/clusters/2000017/tenants/createTenant

{
  "name": "foo",
  "mode": "MYSQL",
  "primaryZone": "zone1,zone2;zone2",
  "charset": "utf8mb4",
  "collation": "utf8mb4_general_ci",
  "description": "bar",
  "whitelist": "%",
  "rootPassword": "xxxxx",
  "saveToCredential": true,
  "zones": [
    {
      "name": "zone1",
      "replicaType": "FULL",
      "resourcePool": {
        "unitSpecName": "S1",
        "unitCount": 1
      }
    },
    {
      "name": "zone2",
      "replicaType": "FULL",
      "resourcePool": {
        "unitSpecName": "S1",
        "unitCount": 1
      }
    },
    {
      "name": "zone3",
      "replicaType": "FULL",
      "resourcePool": {
        "unitSpecName": "S1",
        "unitCount": 1
      }
    }
  ]
}

返回示例

{
  "data": {
    "clusterId": 2000017,
    "creator": "admin",
    "executor": "xxx.xxx.xxx.xxx",
    "id": 4000191,
    "name": "Create tenant",
    "operation": "EXECUTE",
    "prohibitRollback": false,
    "startTime": "2022-08-22T19:55:25.902+08:00",
    "status": "RUNNING",
    "subtasks": [
      {
        "description": "Create ob tenant",
        "downstreams": [
          4000198
        ],
        "id": 4000201,
        "name": "Create ob tenant",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 4,
        "status": "PENDING",
        "timeout": 1200,
        "upstreams": [
          4000204
        ]
      },
      {
        "description": "Set ob tenant parameters",
        "downstreams": [
          4000199
        ],
        "id": 4000202,
        "name": "Set ob tenant parameters",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 2,
        "status": "PENDING",
        "timeout": 300,
        "upstreams": [
          4000203
        ]
      },
      {
        "description": "Set whitelist",
        "downstreams": [
          4000203
        ],
        "id": 4000200,
        "name": "Set whitelist",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 3,
        "status": "PENDING",
        "timeout": 300,
        "upstreams": [
          4000195
        ]
      },
      {
        "description": "Update tenant status",
        "downstreams": [
          4000197
        ],
        "id": 4000199,
        "name": "Update tenant status",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 8,
        "status": "PENDING",
        "timeout": 300,
        "upstreams": [
          4000202
        ]
      },
      {
        "description": "Set super user password",
        "downstreams": [
          4000200
        ],
        "id": 4000195,
        "name": "Set super user password",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 0,
        "status": "PENDING",
        "timeout": 300,
        "upstreams": [
          4000198
        ]
      },
      {
        "description": "Sync tenant information",
        "downstreams": [
          4000195
        ],
        "id": 4000198,
        "name": "Sync tenant information",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 5,
        "status": "PENDING",
        "timeout": 300,
        "upstreams": [
          4000201
        ]
      },
      {
        "description": "Prepare create tenant",
        "downstreams": [
          4000201
        ],
        "id": 4000204,
        "name": "Prepare create tenant",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 6,
        "status": "READY",
        "timeout": 30,
        "upstreams": []
      },
      {
        "description": "Import tenant time zone info",
        "downstreams": [],
        "id": 4000196,
        "name": "Import tenant time zone info",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 1,
        "status": "PENDING",
        "timeout": 600,
        "upstreams": [
          4000197
        ]
      },
      {
        "description": "Import tenant srs info",
        "downstreams": [
          4000196
        ],
        "id": 4000197,
        "name": "Import tenant srs info",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 9,
        "status": "PENDING",
        "timeout": 600,
        "upstreams": [
          4000199
        ]
      },
      {
        "description": "Set system variables",
        "downstreams": [
          4000202
        ],
        "id": 4000203,
        "name": "Set system variables",
        "nodeType": "JAVA_TASK",
        "operation": "EXECUTE",
        "parallelIdx": -1,
        "prohibitRollback": false,
        "runTime": 1,
        "seriesId": 7,
        "status": "PENDING",
        "timeout": 300,
        "upstreams": [
          4000200
        ]
      }
    ],
    "taskDefinitionId": -1,
    "tenantId": 3000001,
    "type": "MANUAL"
  },
  "duration": 6390,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2022-08-22T19:55:27.325+08:00",
  "traceId": "dadeade2e6894d46"
}