接口功能介绍
创建数据库用户。*
接口约束
请先订购实例。
URI
POST /v2/user/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | 产品实例id | ||
name | 是 | String | 数据库用户名称 | user2 | |
password | 是 | String | 数据库用户密码,密码必须符合密码策略要求 | ||
profile | 是 | Integer | 密码策略: 1. 复杂度低-临时有效 2. 复杂度中-短期有效 3. 复杂度高-中期有效 4. 复杂度高-长期有效 5. 复杂度高-永久有效 | 3 | |
manageCommand | 否 | Boolean | 是否有执行管理命令权限 | true | |
canHint | 否 | Boolean | 是否有hint权限 | true | |
whitelist | 否 | Boolean | 是否加入系统过载保护白名单 | ||
freeFrontConnection | 否 | Boolean | 是否前端连接数不受限 | ||
groups | 否 | Array of Strings | 分组名列表。注意:公有云只有一个分组(默认分组),且用户必须有该分组权限。因此,本参数在公有云场景,都会设置为默认分组。 | ||
roles | 否 | Array of Strings | 角色名列表 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success | |
result | 否 | String | 创建成功则返回用户id |
请求示例
请求头header
无
请求体body
{
"prodInstId": "cb236d462b924ef7bfba5ecf1d61de2b",
"name": "user4",
"password": "*************",
"profile": 5,
"manageCommand": true,
"canHint": true,
"whitelist": false,
"freeFrontConnection": false,
"groups":[
"默认分组"
],
"roles":[
"role1"
]
}
响应示例
{
"code": 0,
"message": "success",
"result": "/dbproxy_cluster/dbproxy_cluster_0000000121/users/user_0000000743"
}
状态码
请参考 状态码说明。