接口描述
查询实例的账号信息，指定账户名查询指定账号信息，不指定账户名查询非系统账户（不以"pg_"开头）列表。
请求方法
GET
URI
/v1/inst-user/users
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| prodInstId | query | Long | 是 | 实例id |
| username | query | String | 否 | 用户账号 |
| pageNum | query | Integer | 是 | 页码。取值为大于0且不超过Integer的最大值。 |
| pageSize | query | Integer | 是 | 页大小，范围1-500 |
响应参数
| 名称 | 二级节点 | 三级节点 | 类型 | 说明 |
|---|---|---|---|---|
| message | String | 消息提示 | ||
| statusCode | Integer | 状态码 | ||
| returnObj | Object | 返回结果 | ||
| pageNum | Integer | 当前页 | ||
| pageSize | Integer | 页大小 | ||
| pageTotal | Integer | 页码总数 | ||
| total | Integer | 总记录数 | ||
| list | Array | 记录 | ||
| username | String | 数据库账号名称。 | ||
| rolsuper | Boolean | 用户是否具有超级用户权限。 | ||
| rolinherit | Boolean | 用户是否自动继承其所属角色的权限。 | ||
| rolcreaterole | Boolean | 用户是否支持创建其他子用户。 | ||
| rolcreatedb | Boolean | 用户是否可以创建数据库。 | ||
| rolcanlogin | Boolean | 用户是否可以登录数据库。 | ||
| rolconnlimit | Integer | 用户连接实例的最大并发连接数。-1表示没有限制。 | ||
| rolreplication | Boolean | 用户是否属于复制角色。 | ||
| rolbypassrls | Boolean | 用户是否绕过每个行级安全策略。 |
示例
请求示例
/v1/inst_user/describeUsers?pageNum=1&pageSize=2&prodInstId=165821455486900002
响应示例
{
"message": "SUCCESS",
"returnObj": {
"list": [
{
"memberof": "{}",
"rolbypassrls": "f",
"rolcanlogin": "t",
"rolconnlimit": "-1",
"rolcreatedb": "f",
"rolcreaterole": "f",
"rolinherit": "t",
"rolreplication": "f",
"rolsuper": "f",
"username": "readonly"
},
{
"memberof": "{}",
"rolbypassrls": "f",
"rolcanlogin": "t",
"rolconnlimit": "-1",
"rolcreatedb": "f",
"rolcreaterole": "f",
"rolinherit": "t",
"rolreplication": "f",
"rolsuper": "f",
"username": "testuser"
}
],
"pageNum": 1,
"pageSize": 2,
"pageTotal": 3,
"total": 2
},
"statusCode": 800
}
错误码
访问ErrorCodes说明文档查看更多错误码。
