接口功能介绍
分页查询数据库用户列表。
接口约束
请先订购实例。请先创建数据库用户、角色。
URI
GET /v2/user/list
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
prodInstId | 是 | String | 产品实例id | cb236d462b924ef7bfba5ecf1d61de2b | |
pageNow | 否 | Integer | 当前页,若为空或小于1,默认是1 | 1 | |
pageSize | 否 | Integer | 页大小,若为空或小于1,默认是10 | 10 | |
name | 否 | String | 用户名称,模糊搜索,大小写不敏感 | user1 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 返回码 取值范围:0表示成功,1表示失败 | 0 | |
message | 是 | String | 结果描述 | success | |
result | 否 | Array of Objects | 返回对象,列表,若无该字段或该字段为null或者空列表,都代表返回对象为空。 | result |
表 result
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | 用户id | ||
name | 是 | String | 用户名称 | user1 | |
encryptedPassword | 否 | String | 空密码,密码不返回 | ||
type | 是 | String | 用户类型 | common | |
roles | 否 | String | 用户拥有的角色,多个角色逗号隔开 | role1,role2 | |
whitelist | 是 | String | 是否在过载保护白名单,true表示是,false表示否 | false | |
queryCommand | 是 | String | 是否有查询命令权限,true表示是,false表示否 | true | |
freeFrontConnection | 是 | String | 是否前端连接数不受限,true表示是,false表示否 | false | |
manageCommand | 是 | String | 是否有执行管理命令权限,true表示是,false表示否 | false | |
passwordId | 否 | Integer | 密码版本号 | 0 | |
passwordLastUpdate | 否 | Integer | 密码最近更新时间,时间戳 | ||
profile | 是 | String | 密码策略: 1. 复杂度低-临时有效 2. 复杂度中-短期有效 3. 复杂度高-中期有效 4. 复杂度高-长期有效 5. 复杂度高-永久有效 | 复杂度高-中期有效 | |
canHint | 是 | Boolean | 是否有hint权限 | true | |
userPasswordExpiredTime | 否 | Integer | 密码到期时间,时间戳 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"code": 0,
"message": "success",
"result": [
{
"id": "/dbproxy_cluster/dbproxy_cluster_0000000121/users/user_0000000240",
"name": "user1",
"encryptedPassword": "",
"type": "common",
"roles": "role1,role2,role3",
"whitelist": "true",
"queryCommand": "true",
"freeFrontConnection": "false",
"manageCommand": "true",
"passwordId": 1,
"passwordLastUpdate": 1663244765857,
"profile": "复杂度高-中期有效",
"canHint": false,
"userPasswordExpiredTime": 1671020765857
}
]
}
状态码
请参考 状态码说明。