创建用户。
接口说明
本接口用于创建堡垒机的用户,支持添加本地用户、RAM用户、AD用户和LDAP用户。堡垒机管理员为运维员创建登录堡垒机的账户(即新建用户)后,运维员才能使用该账户登录堡垒机运维已授权的主机。
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-bastionhost:CreateUser | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 要新建用户的堡垒机实例的ID。 说明
您可以调用DescribeInstances接口获取该参数。
| bastionhost-cn-st220aw**** |
RegionId | string | 否 | 要新建的用户的堡垒机的地域ID。 说明
地域ID和地域名称的对应关系,请参见地域和可用区。
| cn-hangzhou |
Source | string | 是 | 要新建的用户的来源。取值:
| local |
UserName | string | 是 | 要新建的用户的登录名称。该参数只能由字母、数字、下划线(_)组成,最多支持128字符。 | abc_def |
Password | string | 否 | 要新建的用户的登录密码。 至少8位,至少包含大小写字母、数字、特殊符号,最多支持128字符。 说明
新创建用户来源为本地用户(即Source取值为Local)时,该参数为必填项。
| 213**** |
DisplayName | string | 否 | 要新建的用户的显示姓名。最多支持128字符。 | Bob |
Comment | string | 否 | 要新建的用户的备注信息。最多支持500字符。 | comment |
string | 否 | 要新建的用户的邮箱。 | username@example.com | |
Mobile | string | 否 | 要新建的用户的手机号码。 | 1359999**** |
SourceUserId | string | 否 | 要新建的用户的唯一标识。 说明
| 122748924538**** |
MobileCountryCode | string | 否 | 要新建的用户手机号的国际域名。默认值为CN,取值:
| CN |
EffectiveStartTime | long | 否 | 用户有效期开始时间(秒,时间戳格式) | 1669630029 |
EffectiveEndTime | long | 否 | 用户有效期结束时间(秒,时间戳格式) | 1672502400 |
NeedResetPassword | boolean | 否 | 下次登录是否需要重置密码。取值:
| true |
TwoFactorStatus | string | 否 | 用户双因子状态,取值:
| Enable |
TwoFactorMethods | string | 否 | 打开双因子认证方式的数组,目前最多支持一个,取值:
说明
| ["sms"] |
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回参数
示例
正常返回示例
JSON
格式
{
"UserId": "1",
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The argument is invalid. | 参数错误 |
400 | UserAlreadyExists | The user already exists. | 用户已存在 |
500 | InternalError | An unknown error occurred. | 未知错误 |
访问错误中心查看更多错误码。