更新时间:2022-08-16 GMT+08:00

查询DDM帐号列表

功能介绍

查询DDM帐号列表。

接口约束

无。

URI

GET /v1/{project_id}/instances/{instance_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

instance_id

String

DDM实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Number

分页参数:起始值 [大于等于0] 。

最小值:0

limit

Number

分页参数:每页多少条 [大于0且小于等于128]。

最小值:1

最大值:128

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 202

表4 响应Body参数

参数

参数类型

描述

users

Array of GetDDMUsersListDetailResponses objects

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

page_no

Integer

当前页码。

page_size

Integer

当前页码的数据条数。

total_record

Integer

总条数。

total_page

Integer

总页数。

表5 查询DDM帐号列表

参数

参数类型

描述

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

description

String

DDM实例帐号的描述。

created

String

DDM实例帐号的创建时间。

databases

Array of GetDDMUsersListdatabase objects

关联的逻辑库的集合。

表6 查询DDM逻辑库帐号列表信息

参数

参数类型

描述

name

String

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

description

String

逻辑库的描述信息。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码

error_msg

String

错误信息

状态码: 500

表8 响应Body参数

参数

参数类型

描述

errCode

String

业务错误码

error_msg

String

错误信息

请求示例

null

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

响应示例

状态码: 202

OK

{
  "users" : [ {
    "name" : "ddmtest",
    "status" : "RUNNING",
    "base_authority" : [ "SELECT" ],
    "extend_authority" : [ "fulltableSelect" ],
    "description" : "帐号",
    "created" : "2019-10-30T11:01:24+0800",
    "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 failure

{ 
 "error_code": "DDM.2061", 
 "error_msg": "Server failure" 
}

状态码

请参见状态码

错误码

请参见错误码