调用GetUser接口获取特定的用户信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetUser

系统规定参数。取值:GetUser

Tid Long 3***

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

Uid String 22973492647626****

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

UserId String 51****

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

RegionId String cn-hangzhou

DMS服务地域,请您根据应用所在地就近选择。取值请参见RegionID参数说明

返回数据

名称 类型 示例值 描述
User Object

用户信息。

State String NORMAL

用户状态,返回值说明如下:

  • NORMAL:正常
  • DISABLE:禁用
  • DELETE:已删除
CurResultCount Long 28

当天查询行数。

UserId String 51****

用户ID。

LastLoginTime String 2021-11-08 11:26:21

最后登录控制台时间。

MaxResultCount Long 10000

当天最高查询行数。

ParentUid Long 140692647406****

主账号UID。

说明 同一主账号UID下包含多个子账号UID。
RoleIdList Array of Integer 1

角色ID列表,具体角色ID的返回值说明如下:

  • 1:表示角色为普通用户。
  • 2:表示角色为DBA。
  • 3:表示角色为管理员。
  • 4:表示角色为安全管理员。
  • 6:表示角色为结构只读。
RoleNameList Array of String USER

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

  • USER:普通用户
  • DBA:DBA
  • ADMIN:管理员
  • SECURITY_ADMIN:安全管理员
  • STRUCT_READ_ONLY:结构只读
NickName String User_NickName

用户昵称。

MaxExecuteCount Long 2000

当天最高查询次数。

CurExecuteCount Long 3

当天查询次数。

Mobile String 1389223****

用户手机号码。

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

目标用户UID。

Email String Uesr_email

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

说明
  • 如果您已经在控制台界面右上角头像处的通知里配置过电子邮箱,此处将返回。
  • 如果您没有配置过电子邮箱,此处则没有返回。
DingRobot String https://XXX.dingtalk.com/robot/send?access_token=***

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

说明
  • 如果您已经在控制台界面右上角头像处的通知里配置过钉钉机器人,此处将返回。
  • 如果您没有配置过钉钉机器人,此处则没有返回。
Webhook String http://dms-XXX.aliyun.com:8***

Webhook,用于接收消息通知。

说明
  • 如果您已经配置过Webhook,当DMS中有消息通知时,系统会将消息通知发送到您指定的URL地址。
  • 如果您没有配置过,此处则没有返回。
SignatureMethod String NONE

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

  • NONE:不签名
  • HMAC_SHA1:HMAC_SHA1
NotificationMode String EMAIL

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

  • SMS:短信
  • EMAIL:电子邮箱
  • DINGDING:钉钉
  • DINGROBOT:钉钉机器人
  • WEBHOOK:Webhook
RequestId String 804BB128-CAFA-5DD0-BA1E-43DDE488****

请求ID。

ErrorCode String UnknownError

错误码。

ErrorMessage String Unknown server error

错误信息。

Success Boolean true

请求是否成功,返回值如下:

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

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=GetUser
&Tid=3***
&Uid=22973492647626****
&UserId=51****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetUserResponse>
    <User>
        <NotificationMode/>
        <Email>Uesr_email</Email>
        <RoleNameList>
            <RoleNames>USER</RoleNames>
            <RoleNames>ADMIN</RoleNames>
        </RoleNameList>
        <NickName>User_NickName</NickName>
        <MaxExecuteCount>2000</MaxExecuteCount>
        <CurResultCount>28</CurResultCount>
        <LastLoginTime>2021-11-09 13:39:21</LastLoginTime>
        <Uid>22275482072787****</Uid>
        <RoleIdList>
            <RoleIds>1</RoleIds>
            <RoleIds>3</RoleIds>
        </RoleIdList>
        <MaxResultCount>10000</MaxResultCount>
        <State>NORMAL</State>
        <UserId>51****</UserId>
        <CurExecuteCount>3</CurExecuteCount>
        <ParentUid>140692647406****</ParentUid>
    </User>
    <RequestId>804BB128-CAFA-5DD0-BA1E-43DDE488****</RequestId>
    <Success>true</Success>
</GetUserResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "User" : {
    "NotificationMode" : "",
    "Email" : "Uesr_email",
    "RoleNameList" : {
      "RoleNames" : [ "USER", "ADMIN" ]
    },
    "NickName" : "User_NickName",
    "MaxExecuteCount" : 2000,
    "CurResultCount" : 28,
    "LastLoginTime" : "2021-11-09 13:39:21",
    "Uid" : "22275482072787****",
    "RoleIdList" : {
      "RoleIds" : [ 1, 3 ]
    },
    "MaxResultCount" : 10000,
    "State" : "NORMAL",
    "UserId" : "51****",
    "CurExecuteCount" : 3,
    "ParentUid" : "140692647406****"
  },
  "RequestId" : "804BB128-CAFA-5DD0-BA1E-43DDE488****",
  "Success" : true
}

错误码

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