UpdateGroup - 更新用户组信息--访问控制-火山引擎

文档中心

立即注册

导航

UpdateGroup - 更新用户组信息

最近更新时间：2025.06.11 16:04:37首次发布时间：2023.09.04 18:10:32

更新指定用户组的信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateGroup	要执行的操作，取值：UpdateGroup。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
UserGroupName	String	是	dev-group	用户组名。
NewUserGroupName	String	否	ops-group	新用户组名。长度1~64，支持英文、数字和.-_符号。
NewDisplayName	String	否	运维组	新显示名。长度不超过64。
NewDescription	String	否	运维组	新描述。长度不超过128。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

GET /?Action=UpdateGroup&Version=2018-01-01&UserGroupName=dev-group&NewUserGroupName=ops-group HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20240911T103635Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240911/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024091118363811415912022051EB4C",
    "Action": "UpdateGroup",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidDescription	Invalid Description 'NewDescription'	描述不合法。
400	InvalidDisplayName	Invalid InvalidDisplayName.	显示名不合法。
400	InvalidUserGroupName	Invalid UserGroupName.	用户组名不合法。
400	ParameterNotFound	Parameter 'UserGroupName' is not found.	参数缺失。
500	ServiceFailure	The requested service failed due to an unknown error	内部服务错误。