调用ListByUserGroupId通过用户组ID批量查询用户组信息-Quick BI-阿里云-智能商业分析 Quick BI(Quick BI)-阿里云帮助中心

根据用户组ID批量查询用户组信息。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:ListByUserGroupId

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
UserGroupIds	string	是	要查询的用户组 ID，批量查询时用半角逗号（,）隔开。	34fe-*-6dcb,84q9-**-4a274

返回参数

名称	类型	描述	示例值
	object
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	true
RequestId	string	请求 ID。	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	object	返回用户组查询结果。
FailedUserGroupIds	array	查询失败的用户组 ID 列表。	[]
	string	查询失败的用户组 ID。	[]
UserGroupModels	array<object>	查询到的用户组详情。
	object
CreateTime	string	创建时间，格式示例为 YYYY-MM-DD HH:mm:ss。	2021-03-15 17:13:55
CreateUser	string	创建者在 Quick BI 的 UserID。	46e5*******ee22e2a292704c8
IdentifiedPath	string	用户组路径。	2fe4fbd8-**-af083ea/34fd1-**-dcbc33f
ModifiedTime	string	修改时间，格式示例为 YYYY-MM-DD HH:mm:ss。	2021-03-15 20:36:40
ModifyUser	string	修改者在 Quick BI 的 UserID。	46e5*******ee22e2a292704c8
ParentUsergroupId	string	上级用户组的 ID。	2fe4fbd8-588f-489a-b3e1-e92c7af083ea
UsergroupDesc	string	用户组描述信息。	描述信息
UsergroupId	string	用户组 ID。	34fd141d-****-4093-8c33-8e066dcbc33f
UsergroupName	string	用户组名称。	测试用户组

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": {
    "FailedUserGroupIds": [
      "[]"
    ],
    "UserGroupModels": [
      {
        "CreateTime": "2021-03-15 17:13:55",
        "CreateUser": "46e5*******ee22e2a292704c8",
        "IdentifiedPath": "2fe4fbd8-****-af083ea/34fd1-****-dcbc33f",
        "ModifiedTime": "2021-03-15 20:36:40",
        "ModifyUser": "46e5*******ee22e2a292704c8",
        "ParentUsergroupId": "2fe4fbd8-588f-489a-b3e1-e92c7af083ea",
        "UsergroupDesc": "描述信息",
        "UsergroupId": "34fd141d-****-4093-8c33-8e066dcbc33f",
        "UsergroupName": "测试用户组"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Usergroup.Not.Exist	The user group does not exist.	用户组不存在。

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

变更历史

更多信息，参考变更详情。