ListByUserGroupId - 批量查询用户组

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
UserGroupIdsstring

要查询的用户组 ID,批量查询时用半角逗号(,)隔开。

34fe-***-6dcb,84q9-****-4a274

返回参数

名称类型描述示例值
object
Successboolean

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

  • true:请求成功
  • false:请求失败
true
RequestIdstring

请求 ID。

D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Resultobject

返回用户组查询结果。

UserGroupModelsarray<object>

查询到的用户组详情。

UserGroupModelsobject
IdentifiedPathstring

用户组路径。

2fe4fbd8-****-af083ea/34fd1-****-dcbc33f
ParentUsergroupIdstring

上级用户组的 ID。

2fe4fbd8-588f-489a-b3e1-e92c7af083ea
ModifiedTimestring

修改时间。

2021-03-15 20:36:40
CreateUserstring

创建者在 Quick BI 的 UserID。

46e5*******ee22e2a292704c8
UsergroupNamestring

用户组名称。

测试用户组
CreateTimestring

创建时间。

2021-03-15 17:13:55
UsergroupDescstring

用户组描述信息。

描述信息
UsergroupIdstring

用户组 ID。

34fd141d-****-4093-8c33-8e066dcbc33f
ModifyUserstring

修改者在 Quick BI 的 UserID。

46e5*******ee22e2a292704c8
FailedUserGroupIdsarray
FailedUserGroupIdsstring

查询失败的用户组 ID。

[]

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Access.ForbiddenAccess forbidden. Your instance version or access key is not allowed to call the API operation.-
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400System.Param.emptyThis error code has been discarded.-
400Usergroup.Not.ExistThe user group does not exist.用户组不存在。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。

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