全部产品
Search

搜索本产品

    数据管理 DMS：GetUser - 获取用户信息

    文档中心

    数据管理 DMS：GetUser - 获取用户信息

    更新时间：Nov 06, 2024

    获取特定的用户信息。

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    dms:GetUserget
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    Tidlong否

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

    		3***
    Uidstring否

    用户 UID。您可以通过 DMS 控制台右上角头像处查看您的 UID。

    		22973492647626****
    UserIdstring否

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

    		51****

    返回参数

    名称类型描述示例值
    object
    Userobject

    用户信息。

    Statestring

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

    • NORMAL：正常
    • DISABLE：禁用
    • DELETE：已删除
    		NORMAL
    CurResultCountlong

    当天查询行数。

    		28
    UserIdstring

    用户 ID。

    		51****
    LastLoginTimestring

    最后登录控制台时间。

    		2021-11-08 11:26:21
    MaxResultCountlong

    当天最高查询行数。

    		10000
    ParentUidlong

    主账号 UID。

    说明 同一主账号 UID 下包含多个子账号 UID。
    		140692647406****
    RoleIdListarray

    角色 ID 列表。

    RoleIdsinteger

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

    • 1：表示角色为普通用户。
    • 2：表示角色为 DBA。
    • 3：表示角色为管理员。
    • 4：表示角色为安全管理员。
    • 6：表示角色为结构只读。
    		1
    RoleNameListarray

    角色名称列表。

    RoleNamesstring

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

    • USER：普通用户
    • DBA：DBA
    • ADMIN：管理员
    • SECURITY_ADMIN：安全管理员
    • STRUCT_READ_ONLY：结构只读
    		USER
    NickNamestring

    用户昵称。

    		User_NickName
    MaxExecuteCountlong

    当天最高查询次数。

    		2000
    CurExecuteCountlong

    当天查询次数。

    		3
    Mobilestring

    用户手机号码。

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

    目标用户 UID。

    		22275482072787****
    Emailstring

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

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

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

    说明
  • 如果您已经在控制台界面右上角头像处的通知里配置过钉钉机器人，此处将返回。
  • 如果您没有配置过钉钉机器人，此处则没有返回。
    •
    		https://XXX.dingtalk.com/robot/send?access_token=***
    Webhookstring

    Webhook，用于接收消息通知。

    说明
  • 如果您已经配置过 Webhook，当 DMS 中有消息通知时，系统会将消息通知发送到您指定的 URL 地址。
  • 如果您没有配置过，此处则没有返回。
    •
    		http://dms-XXX.aliyun.com:8***
    SignatureMethodstring

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

    • NONE：不签名
    • HMAC_SHA1：HMAC_SHA1
    		NONE
    NotificationModestring

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

    • SMS：短信
    • EMAIL：电子邮箱
    • DINGDING：钉钉
    • DINGROBOT：钉钉机器人
    • WEBHOOK：Webhook
    		EMAIL
    RequestIdstring

    请求 ID。

    		804BB128-CAFA-5DD0-BA1E-43DDE488****
    ErrorCodestring

    错误码。

    		UnknownError
    ErrorMessagestring

    错误信息。

    		Unknown server error
    Successboolean

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

    • true：请求成功
    • false：请求失败
    		true

    示例

    正常返回示例

    JSON格式

    {
  "User": {
    "State": "NORMAL",
    "CurResultCount": 28,
    "UserId": "51****",
    "LastLoginTime": "2021-11-08 11:26:21",
    "MaxResultCount": 10000,
    "ParentUid": 0,
    "RoleIdList": {
      "RoleIds": [
        1
      ]
    },
    "RoleNameList": {
      "RoleNames": [
        "USER"
      ]
    },
    "NickName": "User_NickName",
    "MaxExecuteCount": 2000,
    "CurExecuteCount": 3,
    "Mobile": "1389223****",
    "Uid": "22275482072787****",
    "Email": "Uesr_email",
    "DingRobot": "https://XXX.dingtalk.com/robot/send?access_token=***",
    "Webhook": "http://dms-XXX.aliyun.com:8***",
    "SignatureMethod": "NONE",
    "NotificationMode": "EMAIL"
  },
  "RequestId": "804BB128-CAFA-5DD0-BA1E-43DDE488****",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "Unknown server error",
  "Success": true
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史