为终端用户创建便捷账号。
接口说明
便捷账号是无影专用的账号体系,适用于不希望对接企业 AD 的简单场景。便捷账号信息包括用户名、邮箱和手机号。其中,用户名为必填信息,邮箱和手机号至少填写一项。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用全部资源表示。
 
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| ecd:CreateUsers | create | *全部资源 * | 
 | 无 | 
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| Users | array<object> | 是 | 便捷账号信息。 | CreateUsers | 
| object | 是 | 便捷账号信息。 | ||
| EndUserId | string | 是 | 用户名。自定义设置,由小写字母、数字和下划线组成,长度为 3~24 个字符。 | alice | 
| string | 否 | 邮箱。用于接收相关邮件,如分配云电脑的通知邮件。邮箱和手机号二选一必填。 | username@example.com | |
| Phone | string | 否 | 手机号。用于接收相关短信,如分配云电脑的通知短信。邮箱和手机号二选一必填。 | 1381111**** | 
| Password | string | 否 | 用户密码。 说明 
密码长度不少于 10 位,且至少包含大写字母、小写字母、数字、特殊字符(除空格)中的任意三种。
 | Wuying1234 | 
| OwnerType | string | 否 | 账号激活类型。 枚举值: 
 | Normal | 
| OrgId | string | 否 | 用户所属的组织。 | design | 
| Remark | string | 否 | 用户备注。 | remark1 | 
| RealNickName | string | 否 | 用户的显示名。 | Bean | 
| Password | string | 否 | 初始密码。如果不设置,将发送重置密码邮件到用户邮箱。 | Test123**** | 
| AutoLockTime | string | 否 | 自动锁定账号的日期。 | 2023-03-03 | 
| IsLocalAdmin | boolean | 否 | 是否将该便捷账号设为本地管理员。 | true | 
| PasswordExpireDays | string | 否 | 用户账号的密码默认为永久有效,可通过此参数设置 30~365 天的密码有效期,当密码到期后,终端用户必须先修改密码才能继续登录。 说明 
该功能目前处于邀测中,如需体验,请提交工单申请开通。
 | 30 | 
返回参数
示例
正常返回示例
JSON格式
{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "CreateResult": {
    "CreatedUsers": [
      {
        "EndUserId": "test1",
        "Email": "username@example.com",
        "Phone": "1381111****",
        "Remark": "remark1",
        "RealNickName": "Bean"
      }
    ],
    "FailedUsers": [
      {
        "EndUserId": "test2",
        "Email": "username2@example.com",
        "Phone": "1390000****",
        "ErrorCode": "ExistedEndUserId",
        "ErrorMessage": "The username test is used by another user."
      }
    ]
  },
  "AllSucceed": true
}错误码
| HTTP status code | 错误码 | 错误信息 | 
|---|---|---|
| 400 | INTERNAL_ERROR | Internal error. | 
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | 
|---|---|---|
| 2024-12-03 | OpenAPI 错误码发生变更 | 查看变更详情 | 
| 2024-04-09 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 | 
| 2024-01-16 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 | 
| 2023-08-31 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 | 
| 2021-04-02 | 新增 OpenAPI | 查看变更详情 | 
