查询数据库角色列表
调试
您可以在API Explorer中调试该接口。
URI
GET /v3.1/{project_id}/instances/{instance_id}/db-role
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
|
instance_id |
是 |
String |
参数解释: 实例ID。标识实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 默认取值: 不涉及。 |
|
offset |
否 |
Integer |
参数解释: 分页符。从第一条数据偏移offset页数据后开始查询例如:该参数指定为1,limit指定为10,则只展示第11-20条数据。 约束限制: 不涉及。 取值范围: [0, 2^31-1] 默认取值: 默认为0(偏移0条数据,表示从第一条数据开始查询)。 |
|
limit |
否 |
Integer |
参数解释: 每页显示的条目数量。 约束限制: 不涉及。 取值范围: [1, 100] 默认取值: 默认为10。 |
请求参数
无。
响应参数
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
roles |
Array of objects |
参数解释: 列表中每个元素表示一个数据库用户/角色,详情参见表表3 roles字段数据结构说明。 |
|
total_count |
Integer |
参数解释: 总记录数。 取值范围: [0, 2^31-1],取决于实际查询大小。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 用户/角色名称。 取值范围: 不涉及。 |
|
attribute |
Object |
参数解释: 用户/角色的权限属性,详情参见表 attribute字段数据结构说明。 |
|
memberof |
String |
参数解释: 用户/角色的默认权限。 取值范围: 不涉及。 |
|
lock_status |
Boolean |
参数解释: 用户/角色是否被锁。 取值范围: 取值为“true”或“false”。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
rolsuper |
Boolean |
参数解释: 用户/角色是否具有管理员权限。 取值范围: 取值为“true”或“false”。 |
|
rolinherit |
Boolean |
参数解释: 用户/角色是否自动继承其所属角色的权限。 取值范围: 取值为“true”或“false”。 |
|
rolcreaterole |
Boolean |
参数解释: 用户/角色是否支持创建其他子用户。 取值范围: 取值为“true”或“false”。 |
|
rolcreatedb |
Boolean |
参数解释: 用户/角色是否可以创建数据库。 取值范围: 取值为“true”或“false”。 |
|
rolcanlogin |
Boolean |
参数解释: 用户/角色是否可以登录数据库。 取值范围: 取值为“true”或“false”。 |
|
rolconnlimit |
Integer |
参数解释: 用户/角色连接实例的最大并发连接数。-1表示没有限制。 取值范围: 不涉及。 |
|
rolreplication |
Boolean |
参数解释: 用户/角色是否属于复制角色。 取值范围: 取值为“true”或“false”。 |
|
rolbypassrls |
Boolean |
参数解释: 用户/角色是否绕过每个行级安全策略。 取值范围: 取值为“true”或“false”。 |
|
rolpassworddeadline |
String |
参数解释: 用户/角色密码过期时间。 取值范围: 不涉及。 |
请求示例
查询数据库角色列表。
GET https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3.1/054b61972980d4552f0bc00ac8d3f5cd/instances/{instance_id}/db-role
响应示例
查询数据库角色列表成功。
{
"roles": [
{
"name": "root",
"attribute": {
"rolsuper": false,
"rolinherit": true,
"rolcreaterole": true,
"rolcreatedb": true,
"rolcanlogin": true,
"rolconnlimit": -1,
"rolreplication": false,
"rolbypassrls": false,
"rolpassworddeadline": ""
},
"memberof": "{gs_role_copy_files,gs_role_signal_backend,gs_role_tablespace,gs_role_replication,gs_role_account_lock}",
"lock_status": false
}
],
"total_count": 1
}
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。