调用ListUsers接口获取用户详情列表-阿里云帮助中心

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	ListUsers	系统规定参数。取值：ListUsers。
Tid	Long	是	3***	租户ID，可通过调用接口GetUserActiveTenant获取该参数的值。
Role	String	否	DBA	用户角色，取值说明如下： USER：普通用户 DBA：DBA ADMIN：管理员 SECURITY_ADMIN：安全管理员 STRUCT_READ_ONLY：结构只读说明您可在DMS控制台右上角头像处查看您的角色。
UserState	String	否	NORMAL	用户状态，取值说明如下： NORMAL：正常 DISABLE：禁用 DELETE：已删除
SearchKey	String	否	test	搜索关键词，支持模糊搜索。
PageNumber	Integer	否	1	开始页数。
PageSize	Integer	否	10	每页记录数。说明每页记录数，取值：10、20、50、100。默认值为10。

返回数据


名称	类型	示例值	描述
TotalCount	Long	3	满足条件的记录总数。
RequestId	String	67E910F2-4B62-5B0C-ACA3-7547695C****	请求ID。
ErrorCode	String	InvalidTid	错误码。
ErrorMessage	String	Specified parameter Tid is not valid.	错误信息。
UserList	Array of User		用户详情列表。
User
State	String	NORMAL	用户状态，返回值说明如下： NORMAL：正常 DISABLE：禁用 DELETE：已删除
CurResultCount	Long	0	当天查询行数。
UserId	String	8****	用户ID。
LastLoginTime	String	2021-11-08 13:43:43	最后登录时间。
MaxResultCount	Long	50000	当天最高查询行数。
ParentUid	String	140692647406****	父账号UID。
RoleIdList	Array of Integer	3	角色ID列表，具体角色ID的返回值说明如下： 1：表示角色为普通用户。 2：表示角色为DBA。 3：表示角色为管理员。 4：表示角色为安全管理员。 6：表示角色为结构只读。
RoleNameList	Array of String	ADMIN	角色名称列表，具体的角色名称返回值说明如下： USER：普通用户 DBA：DBA ADMIN：管理员 SECURITY_ADMIN：安全管理员 STRUCT_READ_ONLY：结构只读
NickName	String	test_NickName	用户昵称。
MaxExecuteCount	Long	2000	当天最高查询次数。
CurExecuteCount	Long	0	当天查询次数。
Mobile	String	1389999****	用户手机号码。说明如果您已经在控制台界面右上角头像处的通知里配置过手机号码，此处将返回。如果您没有配置过手机号码，此处则没有返回。
Uid	String	167382665015****	用户UID。
Email	String	username@example.com	电子邮箱，用于接收消息通知。说明如果您已经在控制台界面右上角头像处的通知里配置过电子邮箱，此处将返回。如果您没有配置过电子邮箱，此处则没有返回。
DingRobot	String	https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef	钉钉机器人，用于接收消息通知。说明如果您已经在控制台界面右上角头像处的通知里配置过钉钉机器人，此处将返回。如果您没有配置过钉钉机器人，此处则没有返回。
Webhook	String	http://dms-XXX.aliyun.com:8***	Webhook，用于接收消息通知。说明如果您已经配置过Webhook，当DMS中有消息通知时，系统会将消息通知发送到您指定的URL地址。如果您没有配置过，此处则没有返回。
SignatureMethod	String	HMAC_SHA1	Webhook签名方式，返回值说明如下： NONE：不签名 HMAC_SHA1：HMAC_SHA1
NotificationMode	String	DINGROBOT	消息通知方式，返回值可能为多个值，单个返回值说明如下： SMS：短信 EMAIL：电子邮箱 DINGDING：钉钉 DINGROBOT：钉钉机器人 WEBHOOK：Webhook
Success	Boolean	true	请求是否成功，返回值如下： true：请求成功 false：请求失败

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=ListUsers
&Tid=3***
&Role=DBA
&UserState=NORMAL
&SearchKey=test
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

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

<ListUsersResponse>
    <TotalCount>3</TotalCount>
    <RequestId>67E910F2-4B62-5B0C-ACA3-7547695C****</RequestId>
    <UserList>
        <User>
            <Email>test1_email</Email>
            <RoleNameList>
                <RoleNames>DBA</RoleNames>
            </RoleNameList>
            <NickName>王女士</NickName>
            <MaxExecuteCount>2000</MaxExecuteCount>
            <CurResultCount>0</CurResultCount>
            <LastLoginTime>2021-10-22 17:02:19</LastLoginTime>
            <Uid>23236106758310****</Uid>
            <RoleIdList>
                <RoleIds>2</RoleIds>
            </RoleIdList>
            <MaxResultCount>10000</MaxResultCount>
            <State>NORMAL</State>
            <UserId>13****</UserId>
            <CurExecuteCount>1</CurExecuteCount>
            <ParentUid>140692647406****</ParentUid>
        </User>
        <User>
            <Email>test2_email</Email>
            <RoleNameList>
                <RoleNames>ADMIN</RoleNames>
                <RoleNames>USER</RoleNames>
                <RoleNames>SECURITY_ADMIN</RoleNames>
                <RoleNames>DBA</RoleNames>
                <RoleNames>SUPPORT</RoleNames>
            </RoleNameList>
            <NickName>王先生</NickName>
            <MaxExecuteCount>2000</MaxExecuteCount>
            <CurResultCount>400</CurResultCount>
            <LastLoginTime>2021-09-16 10:19:58</LastLoginTime>
            <Uid>26984203785603****</Uid>
            <RoleIdList>
                <RoleIds>3</RoleIds>
                <RoleIds>1</RoleIds>
                <RoleIds>4</RoleIds>
                <RoleIds>2</RoleIds>
                <RoleIds>5</RoleIds>
            </RoleIdList>
            <MaxResultCount>10000</MaxResultCount>
            <State>NORMAL</State>
            <UserId>12****</UserId>
            <CurExecuteCount>5</CurExecuteCount>
            <ParentUid>140692647406****</ParentUid>
        </User>
        <User>
            <NotificationMode>DINGROBOT</NotificationMode>
            <Email>username@example.com</Email>
            <RoleNameList>
                <RoleNames>ADMIN</RoleNames>
                <RoleNames>USER</RoleNames>
                <RoleNames>SECURITY_ADMIN</RoleNames>
                <RoleNames>DBA</RoleNames>
                <RoleNames>STRUCT_READ_ONLY</RoleNames>
            </RoleNameList>
            <NickName>test_NickName</NickName>
            <MaxExecuteCount>2000</MaxExecuteCount>
            <CurResultCount>0</CurResultCount>
            <LastLoginTime>2021-11-08 13:43:43</LastLoginTime>
            <Uid>167382665015****</Uid>
            <RoleIdList>
                <RoleIds>3</RoleIds>
                <RoleIds>1</RoleIds>
                <RoleIds>4</RoleIds>
                <RoleIds>2</RoleIds>
                <RoleIds>6</RoleIds>
            </RoleIdList>
            <MaxResultCount>50000</MaxResultCount>
            <State>NORMAL</State>
            <UserId>8****</UserId>
            <CurExecuteCount>0</CurExecuteCount>
            <Webhook>http://****.aliyun.com:8080</Webhook>
            <SignatureMethod>HMAC_SHA1</SignatureMethod>
            <DingRobot>https://****.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78****</DingRobot>
        </User>
    </UserList>
    <Success>true</Success>
</ListUsersResponse>

JSON格式

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

{
  "TotalCount" : 3,
  "RequestId" : "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "UserList" : {
    "User" : [ {
      "Email" : "test1_email",
      "RoleNameList" : {
        "RoleNames" : [ "DBA" ]
      },
      "NickName" : "王女士",
      "MaxExecuteCount" : 2000,
      "CurResultCount" : 0,
      "LastLoginTime" : "2021-10-22 17:02:19",
      "Uid" : "23236106758310****",
      "RoleIdList" : {
        "RoleIds" : [ 2 ]
      },
      "MaxResultCount" : 10000,
      "State" : "NORMAL",
      "UserId" : "13****",
      "CurExecuteCount" : 1,
      "ParentUid" : "140692647406****"
    }, {
      "Email" : "test2_email",
      "RoleNameList" : {
        "RoleNames" : [ "ADMIN", "USER", "SECURITY_ADMIN", "DBA", "SUPPORT" ]
      },
      "NickName" : "王先生",
      "MaxExecuteCount" : 2000,
      "CurResultCount" : 400,
      "LastLoginTime" : "2021-09-16 10:19:58",
      "Uid" : "26984203785603****",
      "RoleIdList" : {
        "RoleIds" : [ 3, 1, 4, 2, 5 ]
      },
      "MaxResultCount" : 10000,
      "State" : "NORMAL",
      "UserId" : "12****",
      "CurExecuteCount" : 5,
      "ParentUid" : "140692647406****"
    }, {
      "NotificationMode" : "DINGROBOT",
      "Email" : "username@example.com",
      "RoleNameList" : {
        "RoleNames" : [ "ADMIN", "USER", "SECURITY_ADMIN", "DBA", "STRUCT_READ_ONLY" ]
      },
      "NickName" : "test_NickName",
      "MaxExecuteCount" : 2000,
      "CurResultCount" : 0,
      "LastLoginTime" : "2021-11-08 13:43:43",
      "Uid" : "167382665015****",
      "RoleIdList" : {
        "RoleIds" : [ 3, 1, 4, 2, 6 ]
      },
      "MaxResultCount" : 50000,
      "State" : "NORMAL",
      "UserId" : "8****",
      "CurExecuteCount" : 0,
      "Webhook" : "http://****.aliyun.com:8080",
      "SignatureMethod" : "HMAC_SHA1",
      "DingRobot" : "https://****.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78****"
    } ]
  },
  "Success" : true
}

错误码

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