文档首页/ 分布式数据库中间件 DDM/ API参考/ API（推荐）/ 账号管理/ 查询DDM账号列表
更新时间：2024-07-19 GMT+08:00
查看PDF
分享

查询DDM账号列表

功能介绍

查询DDM账号列表。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/instances/{instance_id}/users?offset={offset}&limit={limit}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

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

instance_id

是

String

DDM实例ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

索引位置，偏移量。

从第一条数据偏移offset条数据后开始查询，默认为0。

取值必须为数字，且不能为负数。

limit

否

Integer

查询个数上限值。

取值范围：1~128。

不传该参数时，默认值为10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务的“获取用户Token”接口来获取。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

users

Array of GetUsersListDetailResponses objects

DDM实例账号相关信息的集合。

page_no

Integer

当前页码。

page_size

Integer

当前页码的数据条数。

total_record

Integer

总条数。

total_page

Integer

总页数。
表5 GetUsersListDetailResponses

参数

参数类型

描述

name

String

DDM实例账号名称。

status

String

DDM实例账号状态。

base_authority

Array of strings

DDM实例账号的基础权限。

取值为：CREATE、DROP、ALTER、INDEX、INSERT、DELETE、UPDATE、SELECT

extend_authority

Array of strings

DDM实例账号的扩展权限。

取值为：fulltableDelete、fulltableSelect、fulltableUpdate

password_last_changed

Long

DDM实例账号的密码修改时间，UNIX时间戳格式。

description

String

DDM实例账号的描述。

created

Long

DDM实例账号的创建时间，UNIX时间戳格式。

databases

Array of GetUsersListdatabase objects

关联的逻辑库的集合。
表6 GetUsersListdatabase

参数

参数类型

描述

name

String

DDM实例账号关联的逻辑库名称。

description

String

逻辑库的描述信息。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码。

externalMessage

String

错误信息。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码。

externalMessage

String

错误信息。

请求示例

查询账号列表。

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/users?offset={offset}&limit={limit}

响应示例

状态码： 200

OK

{
  "users" : [ {
    "name" : "ddmtest",
    "status" : "RUNNING",
    "base_authority" : [ "SELECT" ],
   
    "password_last_changed" : 1686904661709,
    "description" : "账号",
    "created" : 1686904661709,
    "databases" : [ {
      "name" : "zhxtest",
      "description" : "逻辑库"
    } ]
  } ],
  "page_no" : 1,
  "page_size" : 10,
  "total_record" : 1,
  "total_page" : 1
}

状态码： 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

状态码： 500

server error

{
  "externalMessage" : "Server failure.",
  "errCode" : "DBS.200412"
}

状态码

状态码

描述

200

OK

400

bad request

500

server error

错误码

请参见错误码。

父主题： 账号管理

相关文档