调用CreateUser接口创建堡垒机用户。
使用说明
本接口用于创建堡垒机的用户,支持添加本地用户和RAM用户。堡垒机管理员为运维员创建登录堡垒机的账户(即新建用户)后,运维员才能使用该账户登录堡垒机运维已授权的主机。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateUser |
需要执行的操作。 取值:CreateUser。 |
InstanceId | String | 是 | bastionhost-cn-st220aw**** |
要新建用户的堡垒机实例的ID。 说明 您可以调用DescribeInstances接口获取该参数。
|
Source | String | 是 | Local |
要新建的用户的来源。取值:
|
UserName | String | 是 | abc_def |
要新建的用户的登录名称。该参数只能由字母、数字、下划线(_)组成,最多支持128字符。 |
RegionId | String | 否 | cn-hangzhou |
要新建的用户的堡垒机的地域ID。 说明 地域ID和地域名称的对应关系,请参见地域和可用区。
|
DisplayName | String | 否 | Bob |
要新建的用户的显示姓名。最多支持128字符。 |
Password | String | 否 | **** |
要新建的用户的登录密码。 最多支持128字符。 说明 新创建用户来源为本地用户(即Source取值为Local)时,该参数为必填项。
|
Comment | String | 否 | comment |
要新建的用户的备注信息。最多支持500字符。 |
String | 否 | 123@qq.com |
要新建的用户的邮箱。 |
|
Mobile | String | 否 | 1359999**** |
要新建的用户的手机号码。 |
SourceUserId | String | 否 | 122748924538**** |
要新建的用户的唯一标识。 说明 该参数是堡垒机用户对应的RAM用户的唯一标识。新创建用户来源为RAM用户(即Source取值为Ram)时,该参数为必填项。您可以调用访问控制的ListUsers接口从返回数据UserId获取该参数。
|
MobileCountryCode | String | 否 | CN |
要新建的用户手机号的国际域名。默认值为CN,取值:
|
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | EC9BF0F4-8983-491A-BC8C-1B4DD94976DE |
本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
UserId | String | 1 |
新建的用户的ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=CreateUser
&InstanceId=bastionhost-cn-st220aw****
&Source=Local
&UserName=abc_def
&<公共请求参数>
正常返回示例
XML
格式
<CreateUserResponse>
<RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
<UserId>1</UserId>
</CreateUserResponse>
JSON
格式
{
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
"UserId": "1"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError | An unknown error occurred. | 未知错误 |
400 | InvalidParameter | The argument is invalid. | 参数错误 |
400 | UserAlreadyExists | The user already exists. | 用户已存在 |
访问错误中心查看更多错误码。