调用CreateTenantUser创建租户用户_云数据库 OceanBase 版(OceanBase)-阿里云帮助中心

在指定租户下创建一个访问数据库的账号。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	OceanBase 集群 ID。	ob317v4uif****
TenantId	string	是	租户 ID。	t4pnum****
UserName	string	是	数据库账号名称。不能使用某些预留关键字，如 SYS、root 等。	pay_test
UserType	string	是	用户类型。 Normal：普通账户。 Admin：超级账户。 ReadonlyAccount：只读账户，仅 MySQL 租户包含只读账户。	Normal
UserPassword	string	是	数据库账号访问密码。说明必须包含大写英文字符、小写英文字符、数字、特殊字符占三种，长度为 10-32 位；特殊字符为：!@#$%^*()_+-=	!Aliyun4Oceanbase
Roles	string	否	用户的角色信息。普通用户填写账户的信息，其为 JSON 格式的字符串，默认为一个数组，数组内包含 Database（MySQL 模式）信息和角色信息（Role）。角色包含以下几类：读写权限（ReadWrite）：ALL PRIVILEGES。只读权限（ReadOnly）：SELECT。 DDL 权限（DDL）：CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW。 DML 权限：SELECT, INSERT, UPDATE, DELETE, SHOW VIEW。 DML 权限（DML）：SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。说明 Oracle 模式：无需填写。 MySQL 模式：超级账户默认为 ALL PRIVILEGES，无需填写。	[{"Database":"oceanbase1","Role":"readwrite"},{"Database":"oceanbase2","Role":"readonly"}]
Description	string	否	数据库描述信息。	this is a test database
EncryptionType	string	否	加密方式。	RAS

有关请求 Endpoint 列表，请参见 API 参考 > 调用方式。

返回参数

名称	类型	描述	示例值
	object	请求的返回结果。
RequestId	string	请求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
TenantUser	object	租户中的数据库账号列表信息。
UserType	string	用户类型。 Normal：普通账户。 Admin：超级账户。 ReadonlyAccount：只读账户，仅 MySQL 租户包含只读账户。	Normal
Roles	array<object>	账户对应的角色权限信息
	object
Database	string	数据库名称。	db_pay1
Role	string	拥有的角色。 Oracle 模式，角色为 Schema 级别，其可分为 ReadWrite：读写权限，包括 CREATE TABLE, CREATE VIEW, CREATE PROCEDURE, CREATE SYNONYM, CREATE SEQUENCE, CREATE TRIGGER, CREATE TYPE, CREATE SESSION EXECUTE ANY PROCEDURE, CREATE ANY OUTLINE, ALTER ANY OUTLINE, DROP ANY OUTLINE, CREATE ANY PROCEDURE, ALTER ANY PROCEDURE, DROP ANY PROCEDURE, CREATE ANY SEQUENCE, ALTER ANY SEQUENCE, DROP ANY SEQUENCE, CREATE ANY TYPE, ALTER ANY TYPE, DROP ANY TYPE SYSKM, CREATE ANY TRIGGER, ALTER ANY TRIGGER, DROP ANY TRIGGER, CREATE PROFILE, ALTER PROFILE, DROP PROFILE； ReadOnly：只读权限，SELECT。 MySQL 模式，角色为数据库（Database）级别，其包括以下几类： ReadWrite：读写权限，包括 ALL PRIVILEGES。 ReadOnly：只读权限，包括 SELECT。 DDL：DDL 权限，包括 CREATE, DROP, ALTER, SHOW VIEW, CREATE VIEW。 DML：DML 权限，包括 SELECT, INSERT, UPDATE, DELETE, SHOW VIEW。说明 Oracle 账户对自己的 Schema 有默认的读写权限，此处不会列出。	ReadOnly
UserStatus	string	数据库账号的状态。 LOCKED：锁定。 ONLINE：解锁。说明创建完成的账户默认状态为 ONLINE。	ONLINE
UserName	string	数据库账号名称。	pay_test

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "TenantUser": {
    "UserType": "Normal",
    "Roles": [
      {
        "Database": "db_pay1",
        "Role": "ReadOnly"
      }
    ],
    "UserStatus": "ONLINE",
    "UserName": "pay_test"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error.	内部错误

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-12-26	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-07-04	OpenAPI 错误码发生变更	查看变更详情
2023-04-06	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情