GetUserGroupInfo接口用于根据用户组名称关键字搜索用户组信息。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetUserGroupInfo

要执行的操作。取值：GetUserGroupInfo。
Keyword String 是 测试用户组

用户组名称关键字。

返回数据

名称 类型 示例值 描述
RequestId String BCE45E6D-9304-4F94-86BB-5A772B1615FF

请求ID。
Result Array of Data

用户组信息。
CreateTime String 2021-03-15 17:13:55

用户组创建时间。
CreateUser String 46e5374665ba4b679ee22e2a2927****

子用户组创建者。此处为Quick BI的UserID，而非阿里云的UID。
IdentifiedPath String 2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****

用户组的目录层级。
ModifiedTime String 2021-03-15 20:36:40

用户组最新修改时间。
ModifyUser String 46e5374665ba4b679ee22e2a2927****

用户组修改者。此处为Quick BI的UserID，而非阿里云的UID。
ParentUsergroupId String 2fe4fbd8-588f-489a-b3e1-e92c7af0****

父用户组ID。
UsergroupDesc String 测试描述

用户组备注。
UsergroupId String 34fd141d-4598-4093-8c33-8e066dcb****

用户组ID。
UsergroupName String pop测试用户组01

用户组名称。
Success Boolean true

是否请求成功。取值范围：

  • true：请求成功
  • false：请求失败

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=GetUserGroupInfo
&Keyword=测试用户组
&<公共请求参数>

正常返回示例

XML格式 

<RequestId>BCE45E6D-9304-4F94-86BB-5A772B1615FF</RequestId>
<Success>true</Success>
<Result>
    <ModifyUser>46e5374665ba4b679ee22e2a2927****</ModifyUser>
    <ModifiedTime>2021-03-15 20:36:40</ModifiedTime>
    <UsergroupDesc>测试描述</UsergroupDesc>
    <CreateTime>2021-03-15 17:13:55</CreateTime>
    <IdentifiedPath>2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****</IdentifiedPath>
    <CreateUser>46e5374665ba4b679ee22e2a2927****</CreateUser>
    <ParentUsergroupId>2fe4fbd8-588f-489a-b3e1-e92c7af0****</ParentUsergroupId>
    <UsergroupName>pop测试用户组01</UsergroupName>
    <UsergroupId>34fd141d-4598-4093-8c33-8e066dcb****</UsergroupId>
</Result>

JSON格式 

{"RequestId":"BCE45E6D-9304-4F94-86BB-5A772B1615FF","Success":"true","Result":[{"ModifyUser":"46e5374665ba4b679ee22e2a2927****","ModifiedTime":"2021-03-15 20:36:40","UsergroupDesc":"测试描述","CreateTime":"2021-03-15 17:13:55","IdentifiedPath":"2fe4fbd8-588f-489a-b3e1-e92c7af0****/34fd141d-4598-4093-8c33-8e066dcb****","CreateUser":"46e5374665ba4b679ee22e2a2927****","ParentUsergroupId":"2fe4fbd8-588f-489a-b3e1-e92c7af0****","UsergroupName":"pop测试用户组01","UsergroupId":"34fd141d-4598-4093-8c33-8e066dcb****"}]}

错误码

HttpCode 错误码 错误信息 描述
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止，您的实例版本或者 AccessKey不允许调用该 API。
500 Invalid.Organization The specified organizational unit does not exist. 该组织不存在。
500 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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