文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 数据库用户管理/ 查询数据库用户- ListGaussMySqlDatabaseUser
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询数据库用户 - ListGaussMySqlDatabaseUser

功能介绍

查询云数据库 TaurusDB实例数据库用户。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:user:list

    List

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:user:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/db-users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

必须为整数，不能为负数。

取值范围：

≥0

默认取值：

0

limit

否

Integer

参数解释：

查询记录数。

约束限制：

必须为整数，不能为负数。

取值范围：

1-100。

默认取值：

100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

users

Array of ListGaussMySqlDatabaseUser objects

参数解释：

数据库用户列表。

total_count

Integer

参数解释：

实例的数据库用户总数。

取值范围：

不涉及。
表5 ListGaussMySqlDatabaseUser

参数

参数类型

描述

name

String

参数解释：

数据库用户名。

取值范围：

数据库用户名称在1到32个字符之间，由字母、数字、下划线组成，不能包含其他特殊字符。

host

String

参数解释：

主机地址。

取值范围：

  • 若IP地址为%，则表示允许所有地址访问TaurusDB实例。

  • 若IP地址为“10.10.10.%”，则表示10.10.10.X的IP地址都可以访问该TaurusDB实例。

  • 若您需要添加多个IP地址，请用英文逗号隔开（逗号前后都不能加空格），例如192.168.0.1,172.16.213.9。

comment

String

参数解释：

数据库用户备注。

取值范围：

长度不能超过512个字符，不能包含回车和特殊字符!<"='>&。

databases

Array of ListGaussMySqlDatabase objects

参数解释：

数据库列表。
表6 ListGaussMySqlDatabase

参数

参数类型

描述

name

String

参数解释：

数据库名称。

取值范围：

不涉及。

readonly

Boolean

参数解释：

是否为只读权限。

取值范围：

  • true：表示只读。

  • false：表示可读写。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询数据库用户列表。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users?offset=0&limit=100

响应示例

状态码： 200

Success.

{
  "users" : [ {
    "name" : "gaussdb_mysql_user1",
    "host" : "127.0.0.1",
    "comment" : "database_user_comment", 
    "databases" : [ {
      "name" : "test",
      "readonly" : false
    } ]
  } ],
  "total_count" : 1
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 数据库用户管理