UpdateUserGroup接口用于更新组织下指定用户组的信息。

请求参数

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

要执行的操作。取值:UpdateUserGroup。

UserGroupDescription String 分组描述更新后

用户组描述。

  • 格式检查:最大字符长度255
  • 特殊格式校验:中英文数字 _ \ / | () ] [
UserGroupId String f5eeb52e-d9c2-4a8b-80e3-47ab55c2****

用户组ID。

UserGroupName String popapi测试分组01更新后

用户组名称。

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

返回数据

名称 类型 示例值 描述
RequestId String D787E1A3-A93C-424A-B626-C2B05DF8D885

请求ID。

Result Boolean true

接口是否执行成功。取值范围:

  • true:执行成功
  • false:执行失败
Success Boolean true

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

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

示例

请求示例

http(s)://quickbi-public.aliyun.com/?Action=UpdateUserGroup
&UserGroupDescription=<分组描述更新后>
&UserGroupId=f5eeb52e-d9c2-4a8b-80e3-47ab55c2****
&UserGroupName=<popapi测试分组01更新后>
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
<Success>true</Success>
<Result>true</Result>

JSON 格式

{"RequestId":"D787E1A3-A93C-424A-B626-C2B05DF8D885","Success":"true","Result":"true"}

错误码

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 Usergroup.Not.Exist The user group does not exist. 用户组不存在。
500 UserGroup.Remove.RootNode The root user group cannot be deleted. 根用户组不允许删除。
500 UserGroup.Remove.WithChildren This user group contains a child user group and cannot be deleted. 当前用户组包含子用户组,不允许删除。
500 System.Param.Empty You must specify the %s parameter. 参数%s不能为空。
500 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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