全部产品
Search

搜索本产品

    数据管理 DMS：ListUsers - 获取用户详情列表

    文档中心

    数据管理 DMS：ListUsers - 获取用户详情列表

    更新时间：Aug 28, 2026

    获取用户的详情列表。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    dms:ListUsers

    list

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    Tid

    integer

    否

    租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。

    3***
    Role

    string

    否

    用户角色，取值说明如下：

    • USER：普通用户

    • DBA：DBA

    • ADMIN：管理员

    • SECURITY_ADMIN：安全管理员

    • STRUCT_READ_ONLY：结构只读

    说明

    您可在 DMS 控制台右上角头像处查看您的角色。

    DBA
    UserState

    string

    否

    用户状态，取值说明如下：

    • NORMAL：正常

    • DISABLE：禁用

    • DELETE：已删除

    NORMAL
    SearchKey

    string

    否

    搜索关键词，支持模糊搜索。

    test
    PageNumber

    integer

    否

    开始页数。

    1
    PageSize

    integer

    否

    每页记录数。

    说明

    每页记录数，取值：10、20、50、100。默认值为 10。

    10

    返回参数

    名称

    类型

    描述

    示例值

    object

    TotalCount

    integer

    满足条件的记录总数。

    3
    RequestId

    string

    请求 ID。

    69161997-6030-53BA-A333-DBEC83B732FF
    ErrorCode

    string

    错误码。

    InvalidTid
    ErrorMessage

    string

    错误信息。

    Specified parameter Tid is not valid.
    UserList

    object

    User

    array<object>

    用户详情列表。

    array<object>

    用户详情。

    State

    string

    用户状态，返回值说明如下：

    • NORMAL：正常

    • DISABLE：禁用

    • DELETE：已删除

    NORMAL
    CurResultCount

    integer

    当天查询行数。

    0
    UserId

    string

    用户 ID。

    8****
    LastLoginTime

    string

    最后登录时间。

    2021-11-08 13:43:43
    MaxResultCount

    integer

    当天最高查询行数。

    50000
    ParentUid

    string

    父账号 UID。

    140692647406****
    RoleIdList

    object

    RoleIds

    array

    角色 ID 列表。

    integer

    角色 ID 列表，具体角色 ID 的返回值说明如下：

    • 1：表示角色为普通用户。

    • 2：表示角色为 DBA。

    • 3：表示角色为管理员。

    • 4：表示角色为安全管理员。

    • 6：表示角色为结构只读。

    3
    RoleNameList

    object

    RoleNames

    array

    角色列表。

    string

    角色名称列表，具体的角色名称返回值说明如下：

    • USER：普通用户

    • DBA：DBA

    • ADMIN：管理员

    • SECURITY_ADMIN：安全管理员

    • STRUCT_READ_ONLY：结构只读

    ADMIN
    NickName

    string

    用户昵称。

    test_NickName
    MaxExecuteCount

    integer

    当天最高查询次数。

    2000
    CurExecuteCount

    integer

    当天查询次数。

    0
    Mobile

    string

    用户手机号码。

    说明

    • 如果您已经在控制台界面右上角头像处的通知里配置过手机号码，此处将返回。

    • 如果您没有配置过手机号码，此处则没有返回。

    1389999****
    Uid

    string

    用户 UID。

    167382665015****
    Email

    string

    电子邮箱，用于接收消息通知。

    说明

    • 如果您已经在控制台界面右上角头像处的通知里配置过电子邮箱，此处将返回。

    • 如果您没有配置过电子邮箱，此处则没有返回。

    username@example.com
    DingRobot

    string

    钉钉机器人，用于接收消息通知。

    说明

    • 如果您已经在控制台界面右上角头像处的通知里配置过钉钉机器人，此处将返回。

    • 如果您没有配置过钉钉机器人，此处则没有返回。

    https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef
    Webhook

    string

    Webhook，用于接收消息通知。

    说明

    • 如果您已经配置过 Webhook，当 DMS 中有消息通知时，系统会将消息通知发送到您指定的 URL 地址。

    • 如果您没有配置过，此处则没有返回。

    http://dms-XXX.aliyun.com:8***
    SignatureMethod

    string

    Webhook 签名方式，返回值说明如下：

    • NONE：不签名

    • HMAC_SHA1：HMAC_SHA1

    HMAC_SHA1
    NotificationMode

    string

    消息通知方式，返回值可能为多个值，单个返回值说明如下：

    • SMS：短信

    • EMAIL：电子邮箱

    • DINGDING：钉钉

    • DINGROBOT：钉钉机器人

    • WEBHOOK：Webhook

    DINGROBOT
    Success

    boolean

    请求是否成功，返回值如下：

    • true：请求成功

    • false：请求失败

    true

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 3,
  "RequestId": "69161997-6030-53BA-A333-DBEC83B732FF",
  "ErrorCode": "InvalidTid",
  "ErrorMessage": "Specified parameter Tid is not valid.",
  "UserList": {
    "User": [
      {
        "State": "NORMAL",
        "CurResultCount": 0,
        "UserId": "8****",
        "LastLoginTime": "2021-11-08 13:43:43",
        "MaxResultCount": 50000,
        "ParentUid": "140692647406****",
        "RoleIdList": {
          "RoleIds": [
            3
          ]
        },
        "RoleNameList": {
          "RoleNames": [
            "ADMIN"
          ]
        },
        "NickName": "test_NickName",
        "MaxExecuteCount": 2000,
        "CurExecuteCount": 0,
        "Mobile": "1389999****",
        "Uid": "167382665015****",
        "Email": "username@example.com",
        "DingRobot": "https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef",
        "Webhook": "http://dms-XXX.aliyun.com:8***",
        "SignatureMethod": "HMAC_SHA1",
        "NotificationMode": "DINGROBOT"
      }
    ]
  },
  "Success": true
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。