DsgUserGroupQueryUserList

调用DsgUserGroupQueryUserList接口,查询当前租户下的用户或角色列表。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DsgUserGroupQueryUserList

系统规定参数。取值:DsgUserGroupQueryUserList

返回数据

名称

类型

示例值

描述

Success Boolean true

调用是否成功。取值如下:

  • true:调用成功。
  • false:调用失败。
ErrorCode String 1029030003

错误码。

ErrorMessage String param error

错误信息。

HttpStatusCode Integer 400

HTTP状态码。

Data Array of Datas

返回数据。

AccountName String user1

用户名称。

YunAccount String user:user1

阿里云用户名称或RAM角色名称。基于阿里云账号或RAM角色创建用户组时需使用该参数的返回值。

AccountType Integer 2

用户类型。取值如下:

  • 1~5:表示阿里云用户。
  • 6:表示RAM角色。
BaseId String 234

用户ID或角色ID。

ParentAccountId String 123

父用户ID。RAM用户会涉及该参数。

RequestId String 102400001

请求的ID。用于定位日志,排查问题。

示例

请求示例

http(s)://[Endpoint]/?Action=DsgUserGroupQueryUserList
&公共请求参数

正常返回示例

XML格式

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

<DsgUserGroupQueryUserListResponse>
    <Success>true</Success>
    <ErrorCode>1029030003</ErrorCode>
    <ErrorMessage>param error</ErrorMessage>
    <HttpStatusCode>400</HttpStatusCode>
    <Data>
        <AccountName>user1</AccountName>
        <YunAccount>user:user1</YunAccount>
        <AccountType>2</AccountType>
        <BaseId>234</BaseId>
        <ParentAccountId>123</ParentAccountId>
    </Data>
    <RequestId>102400001</RequestId>
</DsgUserGroupQueryUserListResponse>

JSON格式

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

{
  "Success" : true,
  "ErrorCode" : "1029030003",
  "ErrorMessage" : "param error",
  "HttpStatusCode" : 400,
  "Data" : [ {
    "AccountName" : "user1",
    "YunAccount" : "user:user1",
    "AccountType" : 2,
    "BaseId" : "234",
    "ParentAccountId" : "123"
  } ],
  "RequestId" : "102400001"
}

错误码

HttpCode

错误码

错误信息

描述

400 USERGROUP.ACCOUNTLISTSIZE.ERROR The number of account exceeds the limit. 用户数量超限。
400 USERGROUP.ID.ERROR The user group ID does not match the tenant or does not exist. 用户组ID不存在或不属于该租户。
400 USERGROUP.LISTSIZE.ERROR The number of user groups exceeds the limit. 用户组数量超限。
400 USERGROUP.PAGESIZE.ERROR Page size is too large, maximum of 100. 页大小超限,最大为100。
400 USERACCOUNT.OWNER.ERROR User list or owner user does not exist. 用户列表或负责人用户不存在。
400 PARAMS.ERROR param error. 参数错误。
403 PERMISSION.DENIED.ERROR Permission denied 权限不足。
500 UNKNOWN.ERROR unknown error. 未知错误。

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