更新时间:2024-09-11 GMT+08:00

查询数据库用户

功能介绍

查询云数据库 GaussDB(for MySQL)实例数据库用户。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

instance_id

String

实例ID,严格匹配UUID规则。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。

limit

Integer

查询记录数。默认为100,不能为负数,最小值为1,最大值为100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us
  • zh-cn

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

users

Array of ListGaussMySqlDatabaseUser objects

数据库用户列表。

total_count

Integer

实例的数据库用户总数。

表5 ListGaussMySqlDatabaseUser

参数

参数类型

描述

name

String

数据库用户名。

host

String

主机地址。

comment

String

数据库用户备注。

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
}

状态码

请参见状态码

错误码

请参见错误码