CreateUserGroup接口用于在指定组织中新建用户组。

请求参数

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

要执行的操作。取值：CreateUserGroup。
ParentUserGroupId String 是 3d2c23d4-2b41-4af8-a1f5-f6390f32****

父用户组ID。可以将新建的用户组添加到该分组下：

  • 当输入父用户组ID时，新建的用户组会添加到该ID的用户组下。
  • 当输入-1时，新建的用户组会添加到根目录下。
UserGroupDescription String 是 用户分组描述

用户组描述。

  • 格式校验：最大长度255
  • 特殊格式校验：中英文数字 _ \ / | () ] [
UserGroupId String 是 pop0001

用户组唯一ID。

  • 无需传入，系统会自动生成；当用户主动传入UserGroupId时，以用户传入的ID作为用户组ID，用户需要自行保证该ID在组织内唯一。
  • 格式校验：最大长度64，不能为-1，
UserGroupName String 是 杭州财报

用户组名称。

  • 格式校验：最大长度255
  • 特殊格式校验：中英文数字 _ \ / | () ] [

返回数据

名称 类型 示例值 描述
RequestId String 46e5374665ba4b679ee22e2a29270

请求ID。
Result String f5eeb52e-d9c2-4a8b-80e3-47ab55c2****

返回用户组添加成功后的ID。如果添加失败，返回空字符串“”。
Success Boolean true

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

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

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=CreateUserGroup
&ParentUserGroupId=3d2c23d4-2b41-4af8-a1f5-f6390f32****
&UserGroupDescription=<用户分组描述>
&UserGroupName=<杭州财报>
&<公共请求参数>

正常返回示例

XML格式 

<RequestId>46e5374665ba4b679ee22e2a29270</RequestId>
<Success>true</Success>
<Result>f5eeb52e-d9c2-4a8b-80e3-47ab55c2****</Result>

JSON格式 

{"RequestId":"46e5374665ba4b679ee22e2a29270","Success":"true","Result":"f5eeb52e-d9c2-4a8b-80e3-47ab55c2****"}

错误码

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 Invalid.Parameter An error occurred while verifying parameters. 参数验证失败。
500 Usergroup.Not.Exist The user group does not exist. 用户组不存在。
500 Duplicate.Name.Error The name already exists. 命名重复。
500 UserGroup.Parent.NotFound The parent user group does not exist. 父用户组不存在。
500 Duplicate.UserGroup.Id Duplicated usergroupId %s. 重复的用户组ID %s。
500 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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