DsgUserGroupQueryList - 查询数据保护伞的用户组列表

更新时间:
复制为 MD 格式

调用DsgUserGroupQueryList接口,查询数据保护伞的用户组列表。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:DsgUserGroupQueryList

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

分页的页码数。

1

PageSize

integer

每页显示的条数,最大为 100。

10

Name

string

用户组名称关键字。平台会根据该关键字模糊匹配,查询相关用户组信息。

yun_group

Owner

string

用户组的负责人。

user1

ProjectName

string

引擎名称。如需查询 MaxCompute 用户组信息,可配置该参数。

dev_project

userGroupType

integer

返回参数

名称

类型

描述

示例值

object

OpenApiResultModel<PagingResultModel>

Success

boolean

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

  • true:调用成功。

  • false:调用失败。

true

ErrorCode

string

错误码。

1029030003

ErrorMessage

string

错误信息。

param error

HttpStatusCode

integer

HTTP 状态码。

400

PageData

object

分页数据查询结果。

PageNumber

integer

分页的页码数。

1

PageSize

integer

每页显示的条数,最大为 100。

10

TotalCount

integer

返回的用户组总条数。

100

Data

array<object>

用户组列表。

{ "accounts": [ "role_project_scheduler" ], "gmtCreate": "2024-05-10 15:22:18", "gmtModified": "2024-05-10 15:22:18", "id": 1955, "name": "dsg_fin_test-复制", "owner": "UAT" }

object

用户组信息。

Accounts

array

用户组中的用户名集合。

string

用户名。

user1

Id

integer

用户组 ID。

123

GmtCreate

string

用户组的创建时间。

2024-05-10 17:14:44

GmtModified

string

用户组的修改时间。

2024-05-10 17:14:44

Name

string

用户组名称。

test_group

Owner

string

用户组负责人。

user1

mcAggregationInfo

string

RequestId

string

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

102400001

示例

正常返回示例

JSON格式

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "PageData": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Data": [
      {
        "Accounts": [
          "user1"
        ],
        "Id": 123,
        "GmtCreate": "2024-05-10 17:14:44",
        "GmtModified": "2024-05-10 17:14:44",
        "Name": "test_group",
        "Owner": "user1",
        "mcAggregationInfo": ""
      }
    ]
  },
  "RequestId": "102400001"
}

错误码

HTTP status code

错误码

错误信息

描述

400 PARAMS.ERROR param error. 参数错误。
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. 用户列表或负责人用户不存在。
500 UNKNOWN.ERROR unknown error. 未知错误。
403 PERMISSION.DENIED.ERROR Permission denied 权限不足。

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

变更历史

更多信息,参考变更详情