全部产品
Search
文档中心

大数据开发治理平台 DataWorks:DsgUserGroupQueryUserList - 查询当前租户下的用户或角色列表

更新时间:Nov 21, 2024

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
当前API无需请求参数

返回参数

名称类型描述示例值
object

OpenApiResultModel<List>

Successboolean

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

  • true:调用成功。
  • false:调用失败。
true
ErrorCodestring

错误码。

1029030003
ErrorMessagestring

错误信息。

param error
HttpStatusCodeinteger

HTTP 状态码。

400
Dataarray<object>

返回数据。

Datasobject

返回的用户信息。

AccountNamestring

用户名称。

user1
YunAccountstring

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

user:user1
AccountTypeinteger

用户类型。取值如下:

  • 1~5:表示阿里云用户。
  • 6:表示 RAM 角色。
2
BaseIdstring

用户 ID 或角色 ID。

234
ParentAccountIdstring

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

123
RequestIdstring

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

102400001

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400USERGROUP.ACCOUNTLISTSIZE.ERRORThe number of account exceeds the limit.用户数量超限。
400USERGROUP.ID.ERRORThe user group ID does not match the tenant or does not exist.用户组ID不存在或不属于该租户。
400USERGROUP.LISTSIZE.ERRORThe number of user groups exceeds the limit.用户组数量超限。
400USERGROUP.PAGESIZE.ERRORPage size is too large, maximum of 100.页大小超限,最大为100。
400USERACCOUNT.OWNER.ERRORUser list or owner user does not exist.用户列表或负责人用户不存在。
400PARAMS.ERRORparam error.参数错误。
403PERMISSION.DENIED.ERRORPermission denied权限不足。
500UNKNOWN.ERRORunknown error.未知错误。

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