更新时间:2023-11-15 GMT+08:00

获取源库迁移用户列表

功能介绍

数据库的迁移过程中,迁移用户需要进行单独处理,该接口可以查询源库的用户信息。

调试

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

接口约束

仅迁移场景、PostgreSQL同步可用。

URI

GET /v3/{project_id}/jobs/{job_id}/get-src-user

表1 路径参数

参数

是否必选

参数类型

描述

job_id

String

任务ID。

project_id

String

租户在某一Region下的Project ID。

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

指定类型为application/json。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。

X-Language

String

请求语言类型。

缺省值:en-us

取值:

  • en-us
  • zh-cn

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

job_id

String

任务ID。

is_global_password

String

是否使用全局密码。

message

String

错误码。

user_list

Array of objects

用户列表数据。

详情请参见表4

roles_list

Array of objects

角色列表数据。

详情请参见表5

is_success

Boolean

是否成功。

表4 user_list字段数据结构说明

参数

参数类型

描述

id

String

用户账号ID。

account

String

账号。

comment

String

说明。

is_transfer

Boolean

是否支持迁移。

privileges

String

权限。

password

String

密码。

roles

Array of strings

拥有的角色

selected

Boolean

是否选择。

no_privileges

String

无法同步的用户权限。

parent_account

String

父用户。

no_parent_account

String

无法同步父子关系的父用户。

表5 roles_list字段数据结构说明

参数

参数类型

描述

role

String

角色。

comment

String

说明。

is_transfer

Boolean

是否支持迁移。

privileges

String

权限。

inherits_roles

Array of strings

继承的角色。

selected

Boolean

是否选择。

请求示例

https://{endpoint}/v3/0549a6a31000d4e82fd1c00c3d6f2d76/jobs/7f3aaf02-b994-4450-b3fb-6314aa9jb105/get-src-user

响应示例

状态码: 200

OK

{
  "message" : "SUCCESS",
  "user_list" : [ {
    "id" : "admin.testuser2",
    "account" : "admin.testuser2",
    "comment" : "",
    "privileges" : null,
    "password" : null,
    "roles" : [ "admin.clusterAdmin" ],
    "selected" : null,
    "is_transfer" : true
  }, {
    "id" : "admin.test_inc_admin_mgo",
    "account" : "admin.test_inc_admin_mgo",
    "comment" : "",
    "privileges" : null,
    "password" : null,
    "roles" : [ "mgo.read", "admin.readAnyDatabase", "local.read" ],
    "selected" : null,
    "is_transfer" : true
  }, {
    "id" : "fastunit.test_full_fastunit_noread",
    "account" : "fastunit.test_full_fastunit_noread",
    "comment" : "",
    "privileges" : null,
    "password" : null,
    "roles" : [ "admin.readAnyDatabase" ],
    "selected" : null,
    "is_transfer" : true
  }, {
    "id" : "admin.test_full",
    "account" : "admin.test_full",
    "comment" : "",
    "privileges" : null,
    "password" : null,
    "roles" : [ "fastunit.read", "admin.readAnyDatabase" ],
    "selected" : null,
    "is_transfer" : true
  } ],
  "roles_list" : [ {
    "role" : "admin.roletest4",
    "comment" : "",
    "privileges" : "GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, RELOAD, PROCESS, REFERENCES, INDEX, ALTER, SHOW DATABASES, CREATE TEMPORARY TABLES, LOCK TABLES, EXECUTE, REPLICATION SLAVE, REPLICATION CLIENT, CREATE VIEW, SHOW VIEW, CREATE ROUTINE, ALTER ROUTINE, CREATE USER, EVENT, TRIGGER ON *.* GRANT XA_RECOVER_ADMIN ON *.*",
    "selected" : null,
    "is_transfer" : true,
    "inherits_roles" : [ "admin.roletest1", "admin.roletest3", "fastunit.roletest1" ]
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码