调用GetUserGroupInfo根据关键字获取用户组信息_智能商业分析 Quick BI(Quick BI)-阿里云帮助中心

根据用户组名称关键字搜索用户组信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
quickbi-public:GetUserGroupInfo	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Keyword	string	是	用户组名称关键字。	测试用户组

返回参数

名称	类型	描述	示例值
	object
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	true
RequestId	string	请求 ID。	D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5
Result	array<object>	用户组信息。
Data	object
CreateTime	string	用户组创建时间。	2021-03-15 17:13:55
CreateUser	string	子用户组创建者。此处为 Quick BI 的 UserID，而非阿里云的 UID。	46e5374665ba4b679ee22e2a2927****
IdentifiedPath	string	用户组的目录层级。	2fe4fbd8-588f-489a-b3e1-e92c7af0**/34fd141d-4598-4093-8c33-8e066dcb**
ModifiedTime	string	用户组最新修改时间。	2021-03-15 20:36:40
ModifyUser	string	用户组修改者。此处为 Quick BI 的 UserID，而非阿里云的 UID。	46e5374665ba4b679ee22e2a2927****
ParentUsergroupId	string	父用户组 ID。	2fe4fbd8-588f-489a-b3e1-e92c7af0****
UsergroupDesc	string	用户组备注。	测试描述
UsergroupId	string	用户组 ID。	34fd141d-4598-4093-8c33-8e066dcb****
UsergroupName	string	用户组名称。	测试用户组01

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "D7980306-1F08-5A88-9FE7-ECB8B9C4C0F5",
  "Result": [
    {
      "CreateTime": "2021-03-15 17:13:55",
      "CreateUser": "46e5374665ba4b679ee22e2a2927****",
      "IdentifiedPath": "2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****",
      "ModifiedTime": "2021-03-15 20:36:40",
      "ModifyUser": "46e5374665ba4b679ee22e2a2927****",
      "ParentUsergroupId": "2fe4fbd8-588f-489a-b3e1-e92c7af0****",
      "UsergroupDesc": "测试描述",
      "UsergroupId": "34fd141d-4598-4093-8c33-8e066dcb****",
      "UsergroupName": "测试用户组01"
    }
  ]
}

错误码

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