You need to enable JavaScript to run this app.
文档中心
ArkClaw 企业版

ArkClaw 企业版

复制全文
下载 pdf
UserManagement
UpdateUser - 更新用户信息
复制全文
下载 pdf
UpdateUser - 更新用户信息
更新用户信息。​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:UpdateUser​
要执行的操作,取值:UpdateUser。​
​
Version string 必选 示例值:2026-05-01​
API的版本,取值:2026-05-01。​
​
Email string 可选 示例值:zhang**@example.com​
新的邮箱地址。​
  • 不传不更新,传空字符串则将Email置为空。​
  • 最大254字符。​
  • 必须能被net/mail.ParseAddress解析且解析结果完全等于原字符串。​
  • 必须包含“@”,且“@”前后的本地部分(local)和域名部分(domain)均不能为空。​
  • domain 需要包含 “.”,不能有 “..”。​
  • 每个标签(label)只能由字母、数字或“-”组成,且不能以“-”开头或结尾。​
  • 最后一级域名至少包含2个字符。​
​
Name string 可选 示例值:张**​
新用户名称。​
  • 不传不更新,传空字符串则将Name置为空。​
  • 最大255字符。​
​
PhoneNumber string 可选 示例值:+86138****8000​
新PhoneNumber。​
  • 不传不更新,传空字符串则将PhoneNumber置为空。​
  • 必须能按未知region ZZ解析为号码。​
  • 必须是有效号码。​
  • 号码类型必须是MOBILE或FIXED_LINE_OR_MOBILE。​
  • 输入字符串必须已经是严格E.164格式。​
​
PreferredUsername string 可选 示例值:zhang**​
新PreferredUsername。​
  • 不传不更新,传空字符串则将PreferredUsername置为空。​
  • 用户名要求6~64字符,只能包含字母、数字、“.”、“_”、“-”,不能包含连续“..”,不能以数字开头。​
  • 若它本身是合法email形态,则必须等于该用户的Email。​
​
SpaceId string 必选 示例值:csi-yei8347ta8xmf5qd****​
ArkClaw实例所属空间ID。可以在ArkClaw控制台“空间概览”页面的“基本信息”获取。​
​
UserId string 必选 示例值:c09f3913-d6b9-42a2-8533-03568d01****​
用户在身份认证用户池中的唯一标识ID。可以在ArkClaw控制台“用户管理”页面获取。​
​
​
​
返回参数​
本接口无特有的返回参数。更多信息请见返回结构。​
请求示例​
​
POST /?Action=UpdateUser&Version=2026-05-01 HTTP/1.1​
Host: https://arkclaw.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260611T080549Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260611/cn-beijing/arkclaw/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"SpaceId": "csi-yei8347ta8xmf5qd****",​
"UserId": "c09f3913-d6b9-42a2-8533-03568d01****",​
"Name": "zhang**"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20260611160556068194****",​
"Action": "UpdateUser",​
"Version": "2026-05-01",​
"Service": "arkclaw",​
"Region": "cn-beijing"​
},​
"Result": {}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidParameter.Email​
The specified Email format is invalid.​
参数Email格式非法。​
400​
InvalidParameter.EmailVerified​
The specified Email is already verified by another user.​
邮箱已被其他用户验证。​
400​
InvalidParameter.Name​
The specified Name format is invalid.​
参数Name格式非法。​
400​
InvalidParameter.PhoneNumber​
The specified PhoneNumber format is invalid.​
参数PhoneNumber格式非法。​
400​
InvalidParameter.PhoneNumberVerified​
The specified PhoneNumber is already verified by another user.​
手机号已被其他用户验证。​
400​
InvalidParameter.PreferredUsername​
The specified PreferredUsername format is invalid.​
参数PreferredUsername格式非法。​
400​
InvalidParameterCombination​
Incorrect combination of parameters.​
参数组合非法。​
400​
MissingParameter.SpaceId​
The required parameter SpaceId is not supplied.​
参数SpaceId不能为空。​
400​
MissingParameter.UserId​
The required parameter UserId is not supplied.​
参数UserId不能为空。​
404​
InvalidSpace.NotFound​
The specified space does not exist.​
指定的ClawSpace不存在。​
404​
InvalidUser.NotFound​
The specified User does not exist.​
指定的User不存在。​
500​
InternalError​
An internal error has occurred.​
内部错误,请重试。如果多次尝试失败,请提交工单。​
​
​
最近更新时间:2026.06.16 22:27:08
这个页面对您有帮助吗?
有用
有用
无用
无用